API

Customer Controller

May 22, 2026

The Customer Controller provides access to your own customer account within the AdmiralCloud platform. It exposes the central configuration of your tenant, allowing you to retrieve and update account-wide settings and platform behavior.

Key Features

  • Account Configuration: Manage core settings that define how your AdmiralCloud account operates
  • Platform Defaults: Configure default values and behaviors that apply across users, content, and integrations
  • Self-Service Updates: Adjust account-level settings without involving AdmiralCloud support
  • Read & Update Only: Designed for managing the existing customer account — creation and deletion are handled separately by AdmiralCloud

The Customer Controller acts as the single source of truth for your tenant configuration, ensuring that account-wide changes are applied consistently throughout the platform.

Reference

Customer find

GET/v5/customer/:id
IAM Permissions
Feldercustomer.fourEyesPrinciple→individualConfiguration.fourEyesPrinciple
Felderadmin.customerExtendedSettings→individualConfiguration.fourEyesPrincipleindividualConfiguration.imprintindividualConfiguration.template
Feldercustomer.manageImprint→individualConfiguration.imprint
Feldercustomer.manageTemplate→individualConfiguration.template
Felderadmin.customerSecuritySettings→internalConfiguration
Request Parameters
FieldTypeRequiredDescription
fieldstring✗Property to filter the result (e.g. contractConfiguration will only return that property)
≡ allowed values:
internalConfigurationcontractConfigurationindividualConfigurationmediaMetadataConfigurationcontactMetadataConfigurationlicenseMetadataConfiguration
Response
FieldTypeDescription
availableMetadataLanguagesarrayAvailable metadata languages Do not use this anymore
availablePublicAreaSettingsobjectAvailable publicarea setting Do not use this anymore. Use a dedicated call
contactMetadataConfigurationobjectcontactMetadataConfiguration for the customer
contactRelationTypesobjectTBA Do not use this anymore.
contractConfigurationobjectcontractConfiguration for the customer
    └ userLimitintegerConfiguration for maximum number of users allowed in the system
    └ userCostsintegerConfiguration for user-related costs Deprecated
    └ adminLimitintegerConfiguration for maximum number of administrators
    └ assetLimitintegerMaximum number of assets that can be stored in the system
    └ assetCostsfloatConfiguration for asset-related costs Deprecated
    └ storageLimitlongMaximum storage space allowed in bytes
    └ storageLimitHumanstringHuman-readable representation of storage limits. Can not be sent
    └ storageCostsfloatConfiguration for storage-related costs Deprecated
    └ trafficLimitlongMaximum allowed data transfer in bytes
    └ trafficLimitHumanstringHuman-readable representation of traffic limits
    └ trafficCostsfloatCost per unit of data transfer Deprecated
    └ availableMetadataLanguagesarrayConfiguration for supported metadata languages
≡ allowed values:
aaabafaksqamaranhyasavaeayazbabmeubebnbhbibobsbrbgmycacschcezhcucvkwcocrcycsdadedvnldzeleneoeteueefofafjfifrfrfyffkadegdgaglgvelgnguhthahehzhihohrhuhyigisioiiiuieiaidikisitjvjaklknkskakrkkkmkirwkykvkgkokjkulolalvlilnltlblulgmkmhmlmimrmsmkmgmtmnmimsmynanvnrndngnenlnnnbnonyocojoromospafapiplptpsqurmrorornrusgsasiskskslsesmsnsdsostessqscsrsssuswsvtytatttetgtlthbotitotntstktrtwugukuruzvevivocywawoxhyiyozazhzuuni
    └ detectFacesobjectFace detection settings
        └ enabledbooleanEnable/disable face detection feature
        └ automaticbooleanEnable/disable automatic face detection
        └ quotaintegerCredits for this feature per month. If set to -1 unlimited credits are available and will be charged according to the price list.
⟨⟩ range: -1 to 1000000
    └ detectObjectsobjectObject detection settings
        └ enabledbooleanEnable/disable object detection feature
        └ automaticbooleanEnable/disable automatic object detection
        └ quotaintegerCredits for this feature per month. If set to -1 unlimited credits are available and will be charged according to the price list.
⟨⟩ range: -1 to 10000000
    └ speechRecognitionobjectSpeech recognition settings
        └ enabledbooleanEnable/disable speech recognition feature
        └ automaticbooleanEnable/disable automatic speech recognition
        └ quotaintegerCredits for this feature per month. If set to -1 unlimited credits are available and will be charged according to the price list.
⟨⟩ range: -1 to 100000
    └ awsRekognitionobjectConfiguration for AWS Rekognition integration Please use generic properties (detectObjects, detectFaces) instead.
        └ detectLabelsobjectSettings for AWS Rekognition label detection
            └ enabledbooleanEnable/disable label detection feature
            └ automaticbooleanEnable/disable automatic label detection
            └ limitintegerMaximum number of labels to detect
⟨⟩ range: 0 to 100000
        └ detectFacesobjectSettings for AWS Rekognition face detection
            └ enabledbooleanEnable/disable face detection feature
            └ automaticbooleanEnable/disable automatic face detection
            └ limitintegerMaximum number of faces to detect
⟨⟩ range: 0 to 100000
            └ collectionIdstringAWS Rekognition face collection identifier
    └ awsSMSobjectConfiguration for AWS SMS messaging service Deprecated
    └ azureobjectConfiguration for Azure services integration Please use generic properties (translate, ocr) instead.
        └ textTranslationobjectSettings for Azure text translation service
            └ enabledbooleanEnable/disable text translation feature
        └ ocrobjectSettings for Azure OCR service
            └ enabledbooleanEnable/disable OCR feature
            └ minConfidenceintegerMinimum confidence score for OCR results (0-100)
⟨⟩ range: 0 to 100
    └ hardLimitsbooleanIf true, strict limits are enforced
    └ informOnLimitsobjectConfiguration for limit notification settings Use IAM policies instead
        └ enabledbooleanEnable/disable limit notifications
        └ intervalintegerInterval for limit notifications
    └ licensedAssetLimitintegerConfiguration for licensed asset quantity restrictions Deprecated
    └ licensedMediaContainerTypesarrayConfiguration for supported licensed media container formats Deprecated
    └ liveStatsobjectConfiguration for real-time statistics tracking
        └ enabledbooleanEnable/disable liveStats
    └ maxTemplatesobjectConfiguration for template quantity limitations
        └ totalintegerNumber of templates allowed per customer"
    └ retentionPeriodintegerConfiguration for data retention policies Deprecated
    └ transcoderobjectConfiguration for media transcoding service Deprecated
        └ customJobListobjectSettings for custom transcoding jobs
            └ enabledbooleanEnable/disable custom transcoding jobs
            └ alwaysbooleanAlways use custom job list for transcoding
            └ environmentstringEnvironment configuration for transcoding jobs
    └ useIntExtSettingobjectConfiguration for internal/external resource settings Deprecated
contractEndsintegerUnix timestamp of the contract end
contractTemplateintegerTBA Experimental
contractTemplateIdintegerContract Template – TBC Use contractStats.contractTemplateId
createdAtdateTimeDate and time of the creation
creatorintegercreator id of the customer
customerIdHashstringDo not use in production any longer! Identifier of the customer Do not use in production!
flagintegerflag of the customer (1 deactivated/locked, 0 active, 99 test account)
≡ allowed values:
019899
freshnessintegerTimestamp that shows the time this object has been cached
fromCachebooleanIf true, customer object is delivered from cache
individualConfigurationobjectindividualConfiguration for the customer
    └ activatedFeaturesarrayList of activate features
    └ acSyncobjectTBCL Experimental
    └ aiFeaturesarrayConfiguration for AI features like face recognition and clustering
        └ enabledbooleanEnable/disable AI features for the customer
        └ featurestringSpecific AI feature to configure
≡ allowed values:
aiCaptionstext2vecsimilaritySearchsmartTagsfaceRecognitiontranslationawsTagsspeechRecognition
        └ featureFlagsobjectAdditional flags for specific features
    └ autoLogoutTimeintegerNot used Not used anymore
    └ searchobjectNot used Not used anymore
    └ featuresobjectNot used Not used anymore
    └ faceDetectionobjectFace detection settings
        └ thresholdfloatThreshold for similarity. Do not show faces below the threshold. Defaults to 0
⟨⟩ range: -1 to 1
    └ messageLogsobjectTBCL Experimental
    └ burnTimecodeobjectConfiguration for burning timecode into media
        └ fontcolorhexColorColor of the timecode font
        └ fontsizeintegerSize of the timecode font
⟨⟩ range: 9 to 244
        └ boxintegerWhether to show a box around the timecode
≡ allowed values:
01
        └ boxcolorhexColorColor of the box around the timecode
        └ boxborderwintegerWidth of the box border
        └ gravitystringPosition of the timecode on the video
≡ allowed values:
northsouth
        └ offsetintegerOffset of the timecode from the edge
≡ allowed values:
01
    └ contactsobjectContact settings configuration
        └ uiLanguagestringUI language preference for contacts
≡ allowed values:
deen
    └ encryptedMetadataarrayList of metadata fields that should be encrypted. Please note, that in this case the metadata is not searchable!
    └ fourEyesPrincipleobjectConfiguration for four-eyes principle validation customer.fourEyesPrinciple admin.customerExtendedSettings
        └ enabledbooleanEnable/disable four-eyes principle
        └ allowedUsersarrayTBA
        └ deleteAllowedarrayList of userIds who can delete this setting
    └ houseKeepingobjectSystem housekeeping configuration
        └ cleanUpMissingS3object
            └ enabledbooleanEnable/disable S3 cleanup
            └ notesPrefixstringPrefix for cleanup notes
    └ imprintobjectImprint configuration customer.manageImprint admin.customerExtendedSettings
        └ urlurlURL of the imprint page
        └ individualAllowedbooleanWhether individual imprint is allowed
    └ preferredAudioLanguagesarrayList of preferred audio languages
≡ allowed values:
aaabafaksqamaranhyasavaeayazbabmeubebnbhbibobsbrbgmycacschcezhcucvkwcocrcycsdadedvnldzeleneoeteueefofafjfifrfrfyffkadegdgaglgvelgnguhthahehzhihohrhuhyigisioiiiuieiaidikisitjvjaklknkskakrkkkmkirwkykvkgkokjkulolalvlilnltlblulgmkmhmlmimrmsmkmgmtmnmimsmynanvnrndngnenlnnnbnonyocojoromospafapiplptpsqurmrorornrusgsasiskskslsesmsnsdsostessqscsrsssuswsvtytatttetgtlthbotitotntstktrtwugukuruzvevivocywawoxhyiyozazhzusilent
    └ preferredCountriesarrayList of preferred countries
≡ allowed values:
afaxaldzasadaoaiagaramawauatazbsbhbdbbbybebzbjbmbtbobqbabwbvbrioumvgbnbgbfbikhcmcacvkycftdclcncxcccokmcgcdckcrhrcucwcyczdkdjdmdoecegsvgqereeetfkfofjfifrgfpftfgagmgedeghgigrglgdgpgugtgggngwgyhthmhnhkhuisinidciiriqieimilitjmjpjejokzkekikwkglalvlblslrlyliltlumomkmgmwmymvmlmtmhmqmrmuytmxfmmdmcmnmemsmamzmmnanrnpnlncnzninengnunfkpmpnoompkpwpspapgpypephpnplptprqaxkrerorurwblshknlcmfpmvcwssmstsasnrsscslsgsxsksisbsozagskrsseslksdsrsjszsechsytwtjtzthtltgtktotttntrtmtctvvauguaaegbusuyuzvuvevnwfehyezmzwaq
    └ preferredTemplatesobjectTemplate preferences configuration
        └ dropsiteintegerPreferred template for dropsite
        └ downloadlinkintegerPreferred template for download links
        └ pressareaintegerPreferred template for press area
    └ animatedPreviewobject
        └ enabledbooleanEnable/disable animated preview (format: 82)
    └ replaceOriginalobjectSettings for original file replacement
        └ notifybooleanWhether to notify on replacement
        └ versionsbooleanWhether to keep versions on replacement
    └ securityGroupsobjectSecurity group settings
        └ displaySortOrderarrayDisplay sort order of security groups
    └ metadataLanguagesobjectTBCL – UI languages
    └ mediaContainerobjectMediacontainer configuration
        └ defaultSettingsobject
            └ downloadNotAllowedbooleanWhether downloads are restricted
            └ downloadOriginalNotAllowedbooleanWhether original file downloads are restricted
            └ publicAreaNotAllowedbooleanWhether public area access is restricted
            └ embedLinkNotAllowedbooleanWhether embed links are restricted
            └ externalAllowedbooleanWhether external access is allowed
            └ internalOnlybooleanWhether access is internal only
        └ defaultFlagintegerDefault flag for mediacontainers
⟨⟩ range: 0 to 9
        └ prettifyContainerNamebooleanWhether to prettify container names
        └ showIDinMediaContainerSummarybooleanWhether to show IDs in container summaries
        └ releaseManagementobject
            └ enabledbooleanEnable/disable release management
            └ automaticReleasebooleanEnable/disable automatic releases.
            └ userIdintegerUser ID for release management
    └ mediaobjectMedia handling configuration
        └ useOriginalFileExtensionbooleanWhether to preserve original file extensions
        └ useOriginalFilenameForDownloadbooleanIf true, original filename is used for downloads instead of generated filename
        └ useIdSuffixForDownloadbooleanIf true, ID suffix is used for downloads to avoid name collisions
        └ jpgAsJPEGbooleanIf true, JPG files are delivered with .jpeg extension
        └ expiresobjectMedia expiration settings
            └ videoobjectVideo expiration settings
                └ expiresFactorintegerExpiration factor for videos
⟨⟩ range: 1 to 100
                └ expiresintegerDefault expiration time for videos
                └ expiresMinimumintegerMinimum expiration time for videos
            └ audioobjectAudio expiration settings
                └ expiresFactorintegerExpiration factor for audio
                └ expiresintegerDefault expiration time for audio
                └ expiresMinimumintegerMinimum expiration time for audio
            └ imageobjectImage expiration settings
                └ expiresintegerDefault expiration time for images
                └ expiresMinimumintegerMinimum expiration time for images
            └ documentobjectDocument expiration settings
                └ expiresintegerDefault expiration time for documents
                └ expiresMinimumintegerMinimum expiration time for documents
        └ autoRepairMediaobjectMedia repair settings
            └ disabledbooleanDisable automatic media repair
    └ playerConfigurationobjectGeneral settings for playerConfiguration
        └ ignoreAutoGeneratearrayif set, these playerconfigs will not be autoGenerated
    └ rawImageHandlingobjectGeneral settings for playerConfiguration
        └ separateFilesbooleanif true RAW/JPEG pairs will remain separate files
    └ subtitleobjectSubtitle configuration settings
        └ defaultSubtitleSettingIdintegerDefault setting ID for subtitles
        └ disableHLSsubtitlebooleanWhether to disable HLS subtitles
        └ publishbooleanWhether to automatically publish subtitles extracted from media
        └ publishNamestringWhat name to assign to automatically published subtitles extracted from media
    └ subtypesarrayConfiguration for media subtypes Deprecated
        └ typestringType identifier
        └ subtypestringSubtype identifier
        └ i18nobjectInternationalization settings
            └ destringGerman translation
            └ enstringEnglish translation
    └ tagsobjectTag system configuration
        └ objectDetectionobjectObject detection settings
            └ enabledbooleanEnable/disable object detection
            └ minConfidenceintegerMinimum confidence threshold for detection
⟨⟩ range: 0 to 100
            └ tagFlagintegerFlag for object detection tags
≡ allowed values:
010
            └ autoTranslatebooleanEnable/disable automatic translation
            └ fontColorhexColorFont color for detected objects
            └ backgroundColorhexColorBackground color for detected objects
        └ iptcobjectIPTC metadata settings
            └ enabledbooleanEnable/disable IPTC processing
            └ tagFlagintegerFlag for IPTC tags
≡ allowed values:
010
            └ autoTranslatebooleanEnable/disable automatic translation
        └ customobjectCustom tag settings
            └ autoTranslatebooleanEnable/disable automatic translation
        └ restoreDeletedbooleanWhether to restore deleted tags
        └ restoreMergedbooleanWhether to restore merged tags
        └ tagsonomyobjectTag taxonomy settings
            └ enabledbooleanEnable/disable tag taxonomy
            └ parentIdintegerParent ID for taxonomy
        └ searchobjectTag search settings
            └ recentlyUsedForCustomerobjectSettings for recently used tags for the customer
                └ daysintegerNumber of days to consider for recently used tags for the customer
⟨⟩ range: 1 to 30
    └ templateobjectTemplate management configuration customer.manageTemplate admin.customerExtendedSettings
        └ managedTemplatesobject
            └ enabledbooleanEnable/disable managed (by AdmiralCloud) templates. Otherwise template endpoint will only deliver custom templates
    └ transcoderobjectTranscoder configuration
        └ previewImagePositionintegerPosition for preview image generation
    └ useFileNameInPublicAreabooleanWhether to use original filename in public area
    └ useIdSuffixForDownloadbooleanWhether to append ID suffix to downloaded files Please use individualConfiguration.media.useIdSuffixForDownload instead
    └ useIPTCkeywordsAsTagsbooleanWhether to use IPTC keywords as tags (Deprecated) Deprecated
    └ useOriginalFilenameForDownloadbooleanWhether to use original filename for downloads Please use individualConfiguration.media.useOriginalFilenameForDownload instead
    └ reportsarrayStatistic peport configuration settings
        └ titlestringidentifier for report, currently only statistic_mediahub is used
        └ colsarrayColumn settings for reports
    └ directDownloadobjectDirect download configuration
        └ idsarrayAllowed IDs for direct download
        └ enabledbooleanEnable/disable direct download feature
    └ uploadobjectUpload configuration – used in client app, not on backend!
        └ metadataDefaultsobjectDefault metadata settings
            └ ignoreTitlebooleanWhether to ignore title metadata
            └ ignoreDescriptionbooleanWhether to ignore description metadata
            └ ignoreTagsbooleanWhether to ignore tag metadata
internalConfigurationobjectinternalConfiguration for the customer admin.customerSecuritySettings
    └ providerConfigurationsarrayTBA
        └ providerstringTBA
        └ accessKeyIdstringTBA
        └ cloudfrontKeypairIdstringTBA
        └ bucketstringBucket to use
        └ regionstringRegion to use, defaults to eu-central-1
        └ transferAccelerationbooleanIf true, transferAcceleration is active. Please contact support prior to setting this.
        └ typestringType of the provider (upload, export)
≡ allowed values:
upload
        └ defaultbooleanMake this setting the default one
    └ useCIDbooleanIf true, CID ist used instead of internal ID
    └ exportobjectTBA
    └ testAccountbooleanIf true, this is a test account
    └ kmsobjectTBA
        └ enabledbooleanIf true, Metadata encryption is active. Also check individualConfiguration.encryptedFields
        └ keyIdstringAWS Key to use in KMS encryption/decryption
    └ clientBaseUrlsarrayList of client base URLs
        └ clientIdstringClient ID for the base URL
        └ domainfqdnDomain to use for this clientId
    └ errorImagesobjectSetting for custom error messages
        └ enabledbooleanIf true, custom error images are used for media delivery (startNotYet, ended, 404)
ipWhiteListcidrAllowed IPs for the customer. Access from other IPs will be denied.
lastEditorintegerlastEditor of the customer
licenseMetadataConfigurationobjectlicenseMetadataConfiguration for the customer
    └ maxLicensesPerMediaContainerintegerMaximum number of licenses per media container (range: 1-10)
⟨⟩ range: 1 to 10
    └ myTypesOnlybooleanWhen enabled, restricts available license types to user's own types
    └ typesarrayList of available license types (e.g., 'all', 'web', 'print', 'tv', 'radio', 'commercials')
    └ i18nobjectInternationalization settings for license metadata
    └ requiredFieldsDefaultsarrayArray of default field names that should be required (e.g., 'start', 'types')
    └ requiredFieldsarrayArray of field names that must be filled out (e.g., 'start', 'licensor')
    └ fieldsobjectConfiguration for license metadata form fields
        └ titlestringUnique identifier for the field
        └ typestringField type (allowed values: 'input', 'textarea', 'select')
≡ allowed values:
inputtextareaselect
        └ typeAttrarrayArray of attributes specific to the field type
        └ labelTextobjectLocalized label text for the field
        └ sortOrderintegerPosition of the field in the form
        └ isRequiredbooleanIndicates if the field is mandatory
    └ warningStatesobjectConfiguration for license warning states and their visual representation
        └ daysintegerTBCL
        └ statusstringWarning state identifier
        └ colorstringRGB color value for the warning state (e.g., '143, 205, 32')
mediaContainerRelationTypesarrayDEPRECATED Do not use in production!
mediaMetadataConfigurationobjectmediaMetadataConfiguration for the customer
namestringname of the customer
searchConfigurationobjectsearchConfiguration for the customer
securityConfigurationobjectsecurityConfiguration for the customer
    └ cnameobjectGlobal cname for the customer
        └ imagefqdnGlobal cname for image delivery
        └ documentfqdnGlobal cname for document delivery
    └ deleteMediaContainerDescriptionbooleanIf true, a reason for deletion is required and logged.
    └ emailobjectAccount-wide MFA configuration
        └ enabledbooleanTBCL
        └ maskedobjectTBCL
            └ enabledbooleanTBCL
            └ emailemailTBCL
            └ fromobjectTBCL
                └ addressemailTBCL
                └ namestringTBCL
            └ replyToobjectTBCL
                └ addressemailTBCL
                └ namestringTBCL
    └ malwareProtectionobjectActivate malware protection for ingested files
        └ enabledbooleanIf true, malware protection is activated
        └ allowSVGScriptTagbooleanTBCL
    └ mfaobjectAccount-wide MFA configuration
        └ requiredbooleanIf true, all users in account must have MFA enabled
        └ enabledbooleanIf true, MFA is activated
serviceConfigurationobjectserviceConfiguration for the customer
    └ detectLabelsobjectSettings regarding label detection
        └ servicestringService for label detection
≡ allowed values:
aws
        └ enabledbooleanIf true, service is enabled
        └ automaticbooleanIf true, all new uploaded items are send to label detection
        └ limitintegerMaximum number of detections
⟨⟩ range: 0 to 100000
    └ detectFacesobjectSettings regarding face detection
        └ servicestringService for face detection
≡ allowed values:
aws
        └ enabledbooleanIf true, service is enabled
        └ automaticbooleanIf true, all new uploaded items are send to face detection
        └ limitintegerMaximum number of detections
⟨⟩ range: 0 to 100000
        └ collectionIdstringId for the collection
    └ ocrobjectSettings regarding ocr
        └ servicestringService for ocr
≡ allowed values:
azure
        └ enabledbooleanIf true, service is enabled
        └ automaticbooleanIf true, all new uploaded items are send to ocr
        └ minConfidenceintegerConfidence level to activate OCR
⟨⟩ range: 0 to 100
    └ speechRecognitionobjectSettings regarding speechRecognition
        └ servicestringService for speechRecognition
≡ allowed values:
aws
        └ enabledbooleanIf true, service is enabled
        └ automaticbooleanIf true, all new uploaded items are send to speechRecognition
        └ limitintegerLimit for speechRecognition
⟨⟩ range: 0 to 100000
        └ defaultLanguagestringdefaultLanguage for speechRecognition
    └ translationobjectSettings regarding translation
        └ servicestringService for translation
≡ allowed values:
azuredeepl
        └ enabledbooleanIf true, service is enabled
        └ automaticbooleanIf true, all new uploaded items are send to translation
        └ limitintegerLimit for translation
⟨⟩ range: 0 to 100000
updatedAtdateTimeDate and time of the last update

Customer update

PUT/v5/customer/:id
IAM Permissions
Feldercustomer.fourEyesPrinciple→individualConfiguration.fourEyesPrinciple
Felderadmin.customerExtendedSettings→individualConfiguration.fourEyesPrincipleindividualConfiguration.imprintindividualConfiguration.template
Feldercustomer.manageImprint→individualConfiguration.imprint
Feldercustomer.manageTemplate→individualConfiguration.template
Felderadmin.customerSecuritySettings→internalConfiguration
Request Parameters
FieldTypeRequiredDescription
contactMetadataConfigurationobject✗contactMetadataConfiguration for the customer
contractEndsinteger✗Unix timestamp of the contract end
fieldstring✗Return only the given property
≡ allowed values:
individualConfigurationcontactMetadataConfigurationmediaMetadataConfigurationsecurityConfigurationsearchConfigurationlicenseMetadataConfiguration
fieldstring✗Reduce response to that field
flaginteger✗flag of the customer (1 deactivated/locked, 0 active, 99 test account)
≡ allowed values:
019899
idinteger✗ID of the customer to update
individualConfigurationobject✗individualConfiguration for the customer
    └ activatedFeaturesarray✗List of activate features
    └ acSyncobject✗TBCL Experimental
    └ aiFeaturesarray✗Configuration for AI features like face recognition and clustering
        └ enabledboolean✗Enable/disable AI features for the customer
        └ featurestring✗Specific AI feature to configure
≡ allowed values:
aiCaptionstext2vecsimilaritySearchsmartTagsfaceRecognitiontranslationawsTagsspeechRecognition
        └ featureFlagsobject✗Additional flags for specific features
    └ autoLogoutTimeinteger✗Not used Not used anymore
    └ searchobject✗Not used Not used anymore
    └ featuresobject✗Not used Not used anymore
    └ faceDetectionobject✗Face detection settings
        └ thresholdfloat✗Threshold for similarity. Do not show faces below the threshold. Defaults to 0
⟨⟩ range: -1 to 1
    └ messageLogsobject✗TBCL Experimental
    └ burnTimecodeobject✗Configuration for burning timecode into media
        └ fontcolorhexColor✗Color of the timecode font
        └ fontsizeinteger✗Size of the timecode font
⟨⟩ range: 9 to 244
        └ boxinteger✗Whether to show a box around the timecode
≡ allowed values:
01
        └ boxcolorhexColor✗Color of the box around the timecode
        └ boxborderwinteger✗Width of the box border
        └ gravitystring✗Position of the timecode on the video
≡ allowed values:
northsouth
        └ offsetinteger✗Offset of the timecode from the edge
≡ allowed values:
01
    └ contactsobject✗Contact settings configuration
        └ uiLanguagestring✗UI language preference for contacts
≡ allowed values:
deen
    └ encryptedMetadataarray✗List of metadata fields that should be encrypted. Please note, that in this case the metadata is not searchable!
    └ fourEyesPrincipleobject✗Configuration for four-eyes principle validation customer.fourEyesPrinciple admin.customerExtendedSettings
        └ enabledboolean✗Enable/disable four-eyes principle
        └ allowedUsersarray✗TBA
        └ deleteAllowedarray✗List of userIds who can delete this setting
    └ houseKeepingobject✗System housekeeping configuration
        └ cleanUpMissingS3object✗
            └ enabledboolean✗Enable/disable S3 cleanup
            └ notesPrefixstring✗Prefix for cleanup notes
    └ imprintobject✗Imprint configuration customer.manageImprint admin.customerExtendedSettings
        └ urlurl✗URL of the imprint page
        └ individualAllowedboolean✗Whether individual imprint is allowed
    └ preferredAudioLanguagesarray✗List of preferred audio languages
≡ allowed values:
aaabafaksqamaranhyasavaeayazbabmeubebnbhbibobsbrbgmycacschcezhcucvkwcocrcycsdadedvnldzeleneoeteueefofafjfifrfrfyffkadegdgaglgvelgnguhthahehzhihohrhuhyigisioiiiuieiaidikisitjvjaklknkskakrkkkmkirwkykvkgkokjkulolalvlilnltlblulgmkmhmlmimrmsmkmgmtmnmimsmynanvnrndngnenlnnnbnonyocojoromospafapiplptpsqurmrorornrusgsasiskskslsesmsnsdsostessqscsrsssuswsvtytatttetgtlthbotitotntstktrtwugukuruzvevivocywawoxhyiyozazhzusilent
    └ preferredCountriesarray✗List of preferred countries
≡ allowed values:
afaxaldzasadaoaiagaramawauatazbsbhbdbbbybebzbjbmbtbobqbabwbvbrioumvgbnbgbfbikhcmcacvkycftdclcncxcccokmcgcdckcrhrcucwcyczdkdjdmdoecegsvgqereeetfkfofjfifrgfpftfgagmgedeghgigrglgdgpgugtgggngwgyhthmhnhkhuisinidciiriqieimilitjmjpjejokzkekikwkglalvlblslrlyliltlumomkmgmwmymvmlmtmhmqmrmuytmxfmmdmcmnmemsmamzmmnanrnpnlncnzninengnunfkpmpnoompkpwpspapgpypephpnplptprqaxkrerorurwblshknlcmfpmvcwssmstsasnrsscslsgsxsksisbsozagskrsseslksdsrsjszsechsytwtjtzthtltgtktotttntrtmtctvvauguaaegbusuyuzvuvevnwfehyezmzwaq
    └ preferredTemplatesobject✗Template preferences configuration
        └ dropsiteinteger✗Preferred template for dropsite
        └ downloadlinkinteger✗Preferred template for download links
        └ pressareainteger✗Preferred template for press area
    └ animatedPreviewobject✗
        └ enabledboolean✗Enable/disable animated preview (format: 82)
    └ replaceOriginalobject✗Settings for original file replacement
        └ notifyboolean✗Whether to notify on replacement
        └ versionsboolean✗Whether to keep versions on replacement
    └ securityGroupsobject✗Security group settings
        └ displaySortOrderarray✗Display sort order of security groups
    └ metadataLanguagesobject✗TBCL – UI languages
    └ mediaContainerobject✗Mediacontainer configuration
        └ defaultSettingsobject✗
            └ downloadNotAllowedboolean✗Whether downloads are restricted
            └ downloadOriginalNotAllowedboolean✗Whether original file downloads are restricted
            └ publicAreaNotAllowedboolean✗Whether public area access is restricted
            └ embedLinkNotAllowedboolean✗Whether embed links are restricted
            └ externalAllowedboolean✗Whether external access is allowed
            └ internalOnlyboolean✗Whether access is internal only
        └ defaultFlaginteger✗Default flag for mediacontainers
⟨⟩ range: 0 to 9
        └ prettifyContainerNameboolean✗Whether to prettify container names
        └ showIDinMediaContainerSummaryboolean✗Whether to show IDs in container summaries
        └ releaseManagementobject✗
            └ enabledboolean✗Enable/disable release management
            └ automaticReleaseboolean✗Enable/disable automatic releases.
            └ userIdinteger✗User ID for release management
    └ mediaobject✗Media handling configuration
        └ useOriginalFileExtensionboolean✗Whether to preserve original file extensions
        └ useOriginalFilenameForDownloadboolean✗If true, original filename is used for downloads instead of generated filename
        └ useIdSuffixForDownloadboolean✗If true, ID suffix is used for downloads to avoid name collisions
        └ jpgAsJPEGboolean✗If true, JPG files are delivered with .jpeg extension
        └ expiresobject✗Media expiration settings
            └ videoobject✗Video expiration settings
                └ expiresFactorinteger✗Expiration factor for videos
⟨⟩ range: 1 to 100
                └ expiresinteger✗Default expiration time for videos
                └ expiresMinimuminteger✗Minimum expiration time for videos
            └ audioobject✗Audio expiration settings
                └ expiresFactorinteger✗Expiration factor for audio
                └ expiresinteger✗Default expiration time for audio
                └ expiresMinimuminteger✗Minimum expiration time for audio
            └ imageobject✗Image expiration settings
                └ expiresinteger✗Default expiration time for images
                └ expiresMinimuminteger✗Minimum expiration time for images
            └ documentobject✗Document expiration settings
                └ expiresinteger✗Default expiration time for documents
                └ expiresMinimuminteger✗Minimum expiration time for documents
        └ autoRepairMediaobject✗Media repair settings
            └ disabledboolean✗Disable automatic media repair
    └ playerConfigurationobject✗General settings for playerConfiguration
        └ ignoreAutoGeneratearray✗if set, these playerconfigs will not be autoGenerated
    └ rawImageHandlingobject✗General settings for playerConfiguration
        └ separateFilesboolean✗if true RAW/JPEG pairs will remain separate files
    └ subtitleobject✗Subtitle configuration settings
        └ defaultSubtitleSettingIdinteger✗Default setting ID for subtitles
        └ disableHLSsubtitleboolean✗Whether to disable HLS subtitles
        └ publishboolean✗Whether to automatically publish subtitles extracted from media
        └ publishNamestring✗What name to assign to automatically published subtitles extracted from media
    └ subtypesarray✗Configuration for media subtypes Deprecated
        └ typestring✗Type identifier
        └ subtypestring✗Subtype identifier
        └ i18nobject✗Internationalization settings
            └ destring✗German translation
            └ enstring✗English translation
    └ tagsobject✗Tag system configuration
        └ objectDetectionobject✗Object detection settings
            └ enabledboolean✗Enable/disable object detection
            └ minConfidenceinteger✗Minimum confidence threshold for detection
⟨⟩ range: 0 to 100
            └ tagFlaginteger✗Flag for object detection tags
≡ allowed values:
010
            └ autoTranslateboolean✗Enable/disable automatic translation
            └ fontColorhexColor✗Font color for detected objects
            └ backgroundColorhexColor✗Background color for detected objects
        └ iptcobject✗IPTC metadata settings
            └ enabledboolean✗Enable/disable IPTC processing
            └ tagFlaginteger✗Flag for IPTC tags
≡ allowed values:
010
            └ autoTranslateboolean✗Enable/disable automatic translation
        └ customobject✗Custom tag settings
            └ autoTranslateboolean✗Enable/disable automatic translation
        └ restoreDeletedboolean✗Whether to restore deleted tags
        └ restoreMergedboolean✗Whether to restore merged tags
        └ tagsonomyobject✗Tag taxonomy settings
            └ enabledboolean✗Enable/disable tag taxonomy
            └ parentIdinteger✗Parent ID for taxonomy
        └ searchobject✗Tag search settings
            └ recentlyUsedForCustomerobject✗Settings for recently used tags for the customer
                └ daysinteger✗Number of days to consider for recently used tags for the customer
⟨⟩ range: 1 to 30
    └ templateobject✗Template management configuration customer.manageTemplate admin.customerExtendedSettings
        └ managedTemplatesobject✗
            └ enabledboolean✗Enable/disable managed (by AdmiralCloud) templates. Otherwise template endpoint will only deliver custom templates
    └ transcoderobject✗Transcoder configuration
        └ previewImagePositioninteger✗Position for preview image generation
    └ useFileNameInPublicAreaboolean✗Whether to use original filename in public area
    └ useIdSuffixForDownloadboolean✗Whether to append ID suffix to downloaded files Please use individualConfiguration.media.useIdSuffixForDownload instead
    └ useIPTCkeywordsAsTagsboolean✗Whether to use IPTC keywords as tags (Deprecated) Deprecated
    └ useOriginalFilenameForDownloadboolean✗Whether to use original filename for downloads Please use individualConfiguration.media.useOriginalFilenameForDownload instead
    └ reportsarray✗Statistic peport configuration settings
        └ titlestring✗identifier for report, currently only statistic_mediahub is used
        └ colsarray✗Column settings for reports
    └ directDownloadobject✗Direct download configuration
        └ idsarray✗Allowed IDs for direct download
        └ enabledboolean✗Enable/disable direct download feature
    └ uploadobject✗Upload configuration – used in client app, not on backend!
        └ metadataDefaultsobject✗Default metadata settings
            └ ignoreTitleboolean✗Whether to ignore title metadata
            └ ignoreDescriptionboolean✗Whether to ignore description metadata
            └ ignoreTagsboolean✗Whether to ignore tag metadata
ipWhiteListcidr✗Allowed IPs for the customer. Access from other IPs will be denied.
licenseMetadataConfigurationobject✗licenseMetadataConfiguration for the customer
    └ maxLicensesPerMediaContainerinteger✗Maximum number of licenses per media container (range: 1-10)
⟨⟩ range: 1 to 10
    └ myTypesOnlyboolean✗When enabled, restricts available license types to user's own types
    └ typesarray✗List of available license types (e.g., 'all', 'web', 'print', 'tv', 'radio', 'commercials')
    └ i18nobject✗Internationalization settings for license metadata
    └ requiredFieldsDefaultsarray✗Array of default field names that should be required (e.g., 'start', 'types')
    └ requiredFieldsarray✗Array of field names that must be filled out (e.g., 'start', 'licensor')
    └ fieldsobject✗Configuration for license metadata form fields
        └ titlestring✗Unique identifier for the field
        └ typestring✗Field type (allowed values: 'input', 'textarea', 'select')
≡ allowed values:
inputtextareaselect
        └ typeAttrarray✗Array of attributes specific to the field type
        └ labelTextobject✗Localized label text for the field
        └ sortOrderinteger✗Position of the field in the form
        └ isRequiredboolean✗Indicates if the field is mandatory
    └ warningStatesobject✗Configuration for license warning states and their visual representation
        └ daysinteger✗TBCL
        └ statusstring✗Warning state identifier
        └ colorstring✗RGB color value for the warning state (e.g., '143, 205, 32')
mediaMetadataConfigurationobject✗mediaMetadataConfiguration for the customer
namestring✗name of the customer
searchConfigurationobject✗searchConfiguration for the customer
securityConfigurationobject✗securityConfiguration for the customer
    └ cnameobject✗Global cname for the customer
        └ imagefqdn✗Global cname for image delivery
        └ documentfqdn✗Global cname for document delivery
    └ deleteMediaContainerDescriptionboolean✗If true, a reason for deletion is required and logged.
    └ emailobject✗Account-wide MFA configuration
        └ enabledboolean✗TBCL
        └ maskedobject✗TBCL
            └ enabledboolean✗TBCL
            └ emailemail✗TBCL
            └ fromobject✗TBCL
                └ addressemail✗TBCL
                └ namestring✗TBCL
            └ replyToobject✗TBCL
                └ addressemail✗TBCL
                └ namestring✗TBCL
    └ malwareProtectionobject✗Activate malware protection for ingested files
        └ enabledboolean✗If true, malware protection is activated
        └ allowSVGScriptTagboolean✗TBCL
    └ mfaobject✗Account-wide MFA configuration
        └ requiredboolean✗If true, all users in account must have MFA enabled
        └ enabledboolean✗If true, MFA is activated
serviceConfigurationobject✗serviceConfiguration for the customer
    └ detectLabelsobject✗Settings regarding label detection
        └ servicestring✗Service for label detection
≡ allowed values:
aws
        └ enabledboolean✗If true, service is enabled
        └ automaticboolean✗If true, all new uploaded items are send to label detection
        └ limitinteger✗Maximum number of detections
⟨⟩ range: 0 to 100000
    └ detectFacesobject✗Settings regarding face detection
        └ servicestring✗Service for face detection
≡ allowed values:
aws
        └ enabledboolean✗If true, service is enabled
        └ automaticboolean✗If true, all new uploaded items are send to face detection
        └ limitinteger✗Maximum number of detections
⟨⟩ range: 0 to 100000
        └ collectionIdstring✗Id for the collection
    └ ocrobject✗Settings regarding ocr
        └ servicestring✗Service for ocr
≡ allowed values:
azure
        └ enabledboolean✗If true, service is enabled
        └ automaticboolean✗If true, all new uploaded items are send to ocr
        └ minConfidenceinteger✗Confidence level to activate OCR
⟨⟩ range: 0 to 100
    └ speechRecognitionobject✗Settings regarding speechRecognition
        └ servicestring✗Service for speechRecognition
≡ allowed values:
aws
        └ enabledboolean✗If true, service is enabled
        └ automaticboolean✗If true, all new uploaded items are send to speechRecognition
        └ limitinteger✗Limit for speechRecognition
⟨⟩ range: 0 to 100000
        └ defaultLanguagestring✗defaultLanguage for speechRecognition
    └ translationobject✗Settings regarding translation
        └ servicestring✗Service for translation
≡ allowed values:
azuredeepl
        └ enabledboolean✗If true, service is enabled
        └ automaticboolean✗If true, all new uploaded items are send to translation
        └ limitinteger✗Limit for translation
⟨⟩ range: 0 to 100000
Response
FieldTypeDescription
availableMetadataLanguagesarrayAvailable metadata languages Do not use this anymore
availablePublicAreaSettingsobjectAvailable publicarea setting Do not use this anymore. Use a dedicated call
contactMetadataConfigurationobjectcontactMetadataConfiguration for the customer
contactRelationTypesobjectTBA Do not use this anymore.
contractConfigurationobjectcontractConfiguration for the customer
    └ userLimitintegerConfiguration for maximum number of users allowed in the system
    └ userCostsintegerConfiguration for user-related costs Deprecated
    └ adminLimitintegerConfiguration for maximum number of administrators
    └ assetLimitintegerMaximum number of assets that can be stored in the system
    └ assetCostsfloatConfiguration for asset-related costs Deprecated
    └ storageLimitlongMaximum storage space allowed in bytes
    └ storageLimitHumanstringHuman-readable representation of storage limits. Can not be sent
    └ storageCostsfloatConfiguration for storage-related costs Deprecated
    └ trafficLimitlongMaximum allowed data transfer in bytes
    └ trafficLimitHumanstringHuman-readable representation of traffic limits
    └ trafficCostsfloatCost per unit of data transfer Deprecated
    └ availableMetadataLanguagesarrayConfiguration for supported metadata languages
≡ allowed values:
aaabafaksqamaranhyasavaeayazbabmeubebnbhbibobsbrbgmycacschcezhcucvkwcocrcycsdadedvnldzeleneoeteueefofafjfifrfrfyffkadegdgaglgvelgnguhthahehzhihohrhuhyigisioiiiuieiaidikisitjvjaklknkskakrkkkmkirwkykvkgkokjkulolalvlilnltlblulgmkmhmlmimrmsmkmgmtmnmimsmynanvnrndngnenlnnnbnonyocojoromospafapiplptpsqurmrorornrusgsasiskskslsesmsnsdsostessqscsrsssuswsvtytatttetgtlthbotitotntstktrtwugukuruzvevivocywawoxhyiyozazhzuuni
    └ detectFacesobjectFace detection settings
        └ enabledbooleanEnable/disable face detection feature
        └ automaticbooleanEnable/disable automatic face detection
        └ quotaintegerCredits for this feature per month. If set to -1 unlimited credits are available and will be charged according to the price list.
⟨⟩ range: -1 to 1000000
    └ detectObjectsobjectObject detection settings
        └ enabledbooleanEnable/disable object detection feature
        └ automaticbooleanEnable/disable automatic object detection
        └ quotaintegerCredits for this feature per month. If set to -1 unlimited credits are available and will be charged according to the price list.
⟨⟩ range: -1 to 10000000
    └ speechRecognitionobjectSpeech recognition settings
        └ enabledbooleanEnable/disable speech recognition feature
        └ automaticbooleanEnable/disable automatic speech recognition
        └ quotaintegerCredits for this feature per month. If set to -1 unlimited credits are available and will be charged according to the price list.
⟨⟩ range: -1 to 100000
    └ awsRekognitionobjectConfiguration for AWS Rekognition integration Please use generic properties (detectObjects, detectFaces) instead.
        └ detectLabelsobjectSettings for AWS Rekognition label detection
            └ enabledbooleanEnable/disable label detection feature
            └ automaticbooleanEnable/disable automatic label detection
            └ limitintegerMaximum number of labels to detect
⟨⟩ range: 0 to 100000
        └ detectFacesobjectSettings for AWS Rekognition face detection
            └ enabledbooleanEnable/disable face detection feature
            └ automaticbooleanEnable/disable automatic face detection
            └ limitintegerMaximum number of faces to detect
⟨⟩ range: 0 to 100000
            └ collectionIdstringAWS Rekognition face collection identifier
    └ awsSMSobjectConfiguration for AWS SMS messaging service Deprecated
    └ azureobjectConfiguration for Azure services integration Please use generic properties (translate, ocr) instead.
        └ textTranslationobjectSettings for Azure text translation service
            └ enabledbooleanEnable/disable text translation feature
        └ ocrobjectSettings for Azure OCR service
            └ enabledbooleanEnable/disable OCR feature
            └ minConfidenceintegerMinimum confidence score for OCR results (0-100)
⟨⟩ range: 0 to 100
    └ hardLimitsbooleanIf true, strict limits are enforced
    └ informOnLimitsobjectConfiguration for limit notification settings Use IAM policies instead
        └ enabledbooleanEnable/disable limit notifications
        └ intervalintegerInterval for limit notifications
    └ licensedAssetLimitintegerConfiguration for licensed asset quantity restrictions Deprecated
    └ licensedMediaContainerTypesarrayConfiguration for supported licensed media container formats Deprecated
    └ liveStatsobjectConfiguration for real-time statistics tracking
        └ enabledbooleanEnable/disable liveStats
    └ maxTemplatesobjectConfiguration for template quantity limitations
        └ totalintegerNumber of templates allowed per customer"
    └ retentionPeriodintegerConfiguration for data retention policies Deprecated
    └ transcoderobjectConfiguration for media transcoding service Deprecated
        └ customJobListobjectSettings for custom transcoding jobs
            └ enabledbooleanEnable/disable custom transcoding jobs
            └ alwaysbooleanAlways use custom job list for transcoding
            └ environmentstringEnvironment configuration for transcoding jobs
    └ useIntExtSettingobjectConfiguration for internal/external resource settings Deprecated
contractEndsintegerUnix timestamp of the contract end
contractTemplateintegerTBA Experimental
contractTemplateIdintegerContract Template – TBC Use contractStats.contractTemplateId
createdAtdateTimeDate and time of the creation
creatorintegercreator id of the customer
customerIdHashstringDo not use in production any longer! Identifier of the customer Do not use in production!
flagintegerflag of the customer (1 deactivated/locked, 0 active, 99 test account)
≡ allowed values:
019899
freshnessintegerTimestamp that shows the time this object has been cached
fromCachebooleanIf true, customer object is delivered from cache
individualConfigurationobjectindividualConfiguration for the customer
    └ activatedFeaturesarrayList of activate features
    └ acSyncobjectTBCL Experimental
    └ aiFeaturesarrayConfiguration for AI features like face recognition and clustering
        └ enabledbooleanEnable/disable AI features for the customer
        └ featurestringSpecific AI feature to configure
≡ allowed values:
aiCaptionstext2vecsimilaritySearchsmartTagsfaceRecognitiontranslationawsTagsspeechRecognition
        └ featureFlagsobjectAdditional flags for specific features
    └ autoLogoutTimeintegerNot used Not used anymore
    └ searchobjectNot used Not used anymore
    └ featuresobjectNot used Not used anymore
    └ faceDetectionobjectFace detection settings
        └ thresholdfloatThreshold for similarity. Do not show faces below the threshold. Defaults to 0
⟨⟩ range: -1 to 1
    └ messageLogsobjectTBCL Experimental
    └ burnTimecodeobjectConfiguration for burning timecode into media
        └ fontcolorhexColorColor of the timecode font
        └ fontsizeintegerSize of the timecode font
⟨⟩ range: 9 to 244
        └ boxintegerWhether to show a box around the timecode
≡ allowed values:
01
        └ boxcolorhexColorColor of the box around the timecode
        └ boxborderwintegerWidth of the box border
        └ gravitystringPosition of the timecode on the video
≡ allowed values:
northsouth
        └ offsetintegerOffset of the timecode from the edge
≡ allowed values:
01
    └ contactsobjectContact settings configuration
        └ uiLanguagestringUI language preference for contacts
≡ allowed values:
deen
    └ encryptedMetadataarrayList of metadata fields that should be encrypted. Please note, that in this case the metadata is not searchable!
    └ fourEyesPrincipleobjectConfiguration for four-eyes principle validation customer.fourEyesPrinciple admin.customerExtendedSettings
        └ enabledbooleanEnable/disable four-eyes principle
        └ allowedUsersarrayTBA
        └ deleteAllowedarrayList of userIds who can delete this setting
    └ houseKeepingobjectSystem housekeeping configuration
        └ cleanUpMissingS3object
            └ enabledbooleanEnable/disable S3 cleanup
            └ notesPrefixstringPrefix for cleanup notes
    └ imprintobjectImprint configuration customer.manageImprint admin.customerExtendedSettings
        └ urlurlURL of the imprint page
        └ individualAllowedbooleanWhether individual imprint is allowed
    └ preferredAudioLanguagesarrayList of preferred audio languages
≡ allowed values:
aaabafaksqamaranhyasavaeayazbabmeubebnbhbibobsbrbgmycacschcezhcucvkwcocrcycsdadedvnldzeleneoeteueefofafjfifrfrfyffkadegdgaglgvelgnguhthahehzhihohrhuhyigisioiiiuieiaidikisitjvjaklknkskakrkkkmkirwkykvkgkokjkulolalvlilnltlblulgmkmhmlmimrmsmkmgmtmnmimsmynanvnrndngnenlnnnbnonyocojoromospafapiplptpsqurmrorornrusgsasiskskslsesmsnsdsostessqscsrsssuswsvtytatttetgtlthbotitotntstktrtwugukuruzvevivocywawoxhyiyozazhzusilent
    └ preferredCountriesarrayList of preferred countries
≡ allowed values:
afaxaldzasadaoaiagaramawauatazbsbhbdbbbybebzbjbmbtbobqbabwbvbrioumvgbnbgbfbikhcmcacvkycftdclcncxcccokmcgcdckcrhrcucwcyczdkdjdmdoecegsvgqereeetfkfofjfifrgfpftfgagmgedeghgigrglgdgpgugtgggngwgyhthmhnhkhuisinidciiriqieimilitjmjpjejokzkekikwkglalvlblslrlyliltlumomkmgmwmymvmlmtmhmqmrmuytmxfmmdmcmnmemsmamzmmnanrnpnlncnzninengnunfkpmpnoompkpwpspapgpypephpnplptprqaxkrerorurwblshknlcmfpmvcwssmstsasnrsscslsgsxsksisbsozagskrsseslksdsrsjszsechsytwtjtzthtltgtktotttntrtmtctvvauguaaegbusuyuzvuvevnwfehyezmzwaq
    └ preferredTemplatesobjectTemplate preferences configuration
        └ dropsiteintegerPreferred template for dropsite
        └ downloadlinkintegerPreferred template for download links
        └ pressareaintegerPreferred template for press area
    └ animatedPreviewobject
        └ enabledbooleanEnable/disable animated preview (format: 82)
    └ replaceOriginalobjectSettings for original file replacement
        └ notifybooleanWhether to notify on replacement
        └ versionsbooleanWhether to keep versions on replacement
    └ securityGroupsobjectSecurity group settings
        └ displaySortOrderarrayDisplay sort order of security groups
    └ metadataLanguagesobjectTBCL – UI languages
    └ mediaContainerobjectMediacontainer configuration
        └ defaultSettingsobject
            └ downloadNotAllowedbooleanWhether downloads are restricted
            └ downloadOriginalNotAllowedbooleanWhether original file downloads are restricted
            └ publicAreaNotAllowedbooleanWhether public area access is restricted
            └ embedLinkNotAllowedbooleanWhether embed links are restricted
            └ externalAllowedbooleanWhether external access is allowed
            └ internalOnlybooleanWhether access is internal only
        └ defaultFlagintegerDefault flag for mediacontainers
⟨⟩ range: 0 to 9
        └ prettifyContainerNamebooleanWhether to prettify container names
        └ showIDinMediaContainerSummarybooleanWhether to show IDs in container summaries
        └ releaseManagementobject
            └ enabledbooleanEnable/disable release management
            └ automaticReleasebooleanEnable/disable automatic releases.
            └ userIdintegerUser ID for release management
    └ mediaobjectMedia handling configuration
        └ useOriginalFileExtensionbooleanWhether to preserve original file extensions
        └ useOriginalFilenameForDownloadbooleanIf true, original filename is used for downloads instead of generated filename
        └ useIdSuffixForDownloadbooleanIf true, ID suffix is used for downloads to avoid name collisions
        └ jpgAsJPEGbooleanIf true, JPG files are delivered with .jpeg extension
        └ expiresobjectMedia expiration settings
            └ videoobjectVideo expiration settings
                └ expiresFactorintegerExpiration factor for videos
⟨⟩ range: 1 to 100
                └ expiresintegerDefault expiration time for videos
                └ expiresMinimumintegerMinimum expiration time for videos
            └ audioobjectAudio expiration settings
                └ expiresFactorintegerExpiration factor for audio
                └ expiresintegerDefault expiration time for audio
                └ expiresMinimumintegerMinimum expiration time for audio
            └ imageobjectImage expiration settings
                └ expiresintegerDefault expiration time for images
                └ expiresMinimumintegerMinimum expiration time for images
            └ documentobjectDocument expiration settings
                └ expiresintegerDefault expiration time for documents
                └ expiresMinimumintegerMinimum expiration time for documents
        └ autoRepairMediaobjectMedia repair settings
            └ disabledbooleanDisable automatic media repair
    └ playerConfigurationobjectGeneral settings for playerConfiguration
        └ ignoreAutoGeneratearrayif set, these playerconfigs will not be autoGenerated
    └ rawImageHandlingobjectGeneral settings for playerConfiguration
        └ separateFilesbooleanif true RAW/JPEG pairs will remain separate files
    └ subtitleobjectSubtitle configuration settings
        └ defaultSubtitleSettingIdintegerDefault setting ID for subtitles
        └ disableHLSsubtitlebooleanWhether to disable HLS subtitles
        └ publishbooleanWhether to automatically publish subtitles extracted from media
        └ publishNamestringWhat name to assign to automatically published subtitles extracted from media
    └ subtypesarrayConfiguration for media subtypes Deprecated
        └ typestringType identifier
        └ subtypestringSubtype identifier
        └ i18nobjectInternationalization settings
            └ destringGerman translation
            └ enstringEnglish translation
    └ tagsobjectTag system configuration
        └ objectDetectionobjectObject detection settings
            └ enabledbooleanEnable/disable object detection
            └ minConfidenceintegerMinimum confidence threshold for detection
⟨⟩ range: 0 to 100
            └ tagFlagintegerFlag for object detection tags
≡ allowed values:
010
            └ autoTranslatebooleanEnable/disable automatic translation
            └ fontColorhexColorFont color for detected objects
            └ backgroundColorhexColorBackground color for detected objects
        └ iptcobjectIPTC metadata settings
            └ enabledbooleanEnable/disable IPTC processing
            └ tagFlagintegerFlag for IPTC tags
≡ allowed values:
010
            └ autoTranslatebooleanEnable/disable automatic translation
        └ customobjectCustom tag settings
            └ autoTranslatebooleanEnable/disable automatic translation
        └ restoreDeletedbooleanWhether to restore deleted tags
        └ restoreMergedbooleanWhether to restore merged tags
        └ tagsonomyobjectTag taxonomy settings
            └ enabledbooleanEnable/disable tag taxonomy
            └ parentIdintegerParent ID for taxonomy
        └ searchobjectTag search settings
            └ recentlyUsedForCustomerobjectSettings for recently used tags for the customer
                └ daysintegerNumber of days to consider for recently used tags for the customer
⟨⟩ range: 1 to 30
    └ templateobjectTemplate management configuration customer.manageTemplate admin.customerExtendedSettings
        └ managedTemplatesobject
            └ enabledbooleanEnable/disable managed (by AdmiralCloud) templates. Otherwise template endpoint will only deliver custom templates
    └ transcoderobjectTranscoder configuration
        └ previewImagePositionintegerPosition for preview image generation
    └ useFileNameInPublicAreabooleanWhether to use original filename in public area
    └ useIdSuffixForDownloadbooleanWhether to append ID suffix to downloaded files Please use individualConfiguration.media.useIdSuffixForDownload instead
    └ useIPTCkeywordsAsTagsbooleanWhether to use IPTC keywords as tags (Deprecated) Deprecated
    └ useOriginalFilenameForDownloadbooleanWhether to use original filename for downloads Please use individualConfiguration.media.useOriginalFilenameForDownload instead
    └ reportsarrayStatistic peport configuration settings
        └ titlestringidentifier for report, currently only statistic_mediahub is used
        └ colsarrayColumn settings for reports
    └ directDownloadobjectDirect download configuration
        └ idsarrayAllowed IDs for direct download
        └ enabledbooleanEnable/disable direct download feature
    └ uploadobjectUpload configuration – used in client app, not on backend!
        └ metadataDefaultsobjectDefault metadata settings
            └ ignoreTitlebooleanWhether to ignore title metadata
            └ ignoreDescriptionbooleanWhether to ignore description metadata
            └ ignoreTagsbooleanWhether to ignore tag metadata
internalConfigurationobjectinternalConfiguration for the customer admin.customerSecuritySettings
    └ providerConfigurationsarrayTBA
        └ providerstringTBA
        └ accessKeyIdstringTBA
        └ cloudfrontKeypairIdstringTBA
        └ bucketstringBucket to use
        └ regionstringRegion to use, defaults to eu-central-1
        └ transferAccelerationbooleanIf true, transferAcceleration is active. Please contact support prior to setting this.
        └ typestringType of the provider (upload, export)
≡ allowed values:
upload
        └ defaultbooleanMake this setting the default one
    └ useCIDbooleanIf true, CID ist used instead of internal ID
    └ exportobjectTBA
    └ testAccountbooleanIf true, this is a test account
    └ kmsobjectTBA
        └ enabledbooleanIf true, Metadata encryption is active. Also check individualConfiguration.encryptedFields
        └ keyIdstringAWS Key to use in KMS encryption/decryption
    └ clientBaseUrlsarrayList of client base URLs
        └ clientIdstringClient ID for the base URL
        └ domainfqdnDomain to use for this clientId
    └ errorImagesobjectSetting for custom error messages
        └ enabledbooleanIf true, custom error images are used for media delivery (startNotYet, ended, 404)
ipWhiteListcidrAllowed IPs for the customer. Access from other IPs will be denied.
lastEditorintegerlastEditor of the customer
licenseMetadataConfigurationobjectlicenseMetadataConfiguration for the customer
    └ maxLicensesPerMediaContainerintegerMaximum number of licenses per media container (range: 1-10)
⟨⟩ range: 1 to 10
    └ myTypesOnlybooleanWhen enabled, restricts available license types to user's own types
    └ typesarrayList of available license types (e.g., 'all', 'web', 'print', 'tv', 'radio', 'commercials')
    └ i18nobjectInternationalization settings for license metadata
    └ requiredFieldsDefaultsarrayArray of default field names that should be required (e.g., 'start', 'types')
    └ requiredFieldsarrayArray of field names that must be filled out (e.g., 'start', 'licensor')
    └ fieldsobjectConfiguration for license metadata form fields
        └ titlestringUnique identifier for the field
        └ typestringField type (allowed values: 'input', 'textarea', 'select')
≡ allowed values:
inputtextareaselect
        └ typeAttrarrayArray of attributes specific to the field type
        └ labelTextobjectLocalized label text for the field
        └ sortOrderintegerPosition of the field in the form
        └ isRequiredbooleanIndicates if the field is mandatory
    └ warningStatesobjectConfiguration for license warning states and their visual representation
        └ daysintegerTBCL
        └ statusstringWarning state identifier
        └ colorstringRGB color value for the warning state (e.g., '143, 205, 32')
mediaContainerRelationTypesarrayDEPRECATED Do not use in production!
mediaMetadataConfigurationobjectmediaMetadataConfiguration for the customer
namestringname of the customer
searchConfigurationobjectsearchConfiguration for the customer
securityConfigurationobjectsecurityConfiguration for the customer
    └ cnameobjectGlobal cname for the customer
        └ imagefqdnGlobal cname for image delivery
        └ documentfqdnGlobal cname for document delivery
    └ deleteMediaContainerDescriptionbooleanIf true, a reason for deletion is required and logged.
    └ emailobjectAccount-wide MFA configuration
        └ enabledbooleanTBCL
        └ maskedobjectTBCL
            └ enabledbooleanTBCL
            └ emailemailTBCL
            └ fromobjectTBCL
                └ addressemailTBCL
                └ namestringTBCL
            └ replyToobjectTBCL
                └ addressemailTBCL
                └ namestringTBCL
    └ malwareProtectionobjectActivate malware protection for ingested files
        └ enabledbooleanIf true, malware protection is activated
        └ allowSVGScriptTagbooleanTBCL
    └ mfaobjectAccount-wide MFA configuration
        └ requiredbooleanIf true, all users in account must have MFA enabled
        └ enabledbooleanIf true, MFA is activated
serviceConfigurationobjectserviceConfiguration for the customer
    └ detectLabelsobjectSettings regarding label detection
        └ servicestringService for label detection
≡ allowed values:
aws
        └ enabledbooleanIf true, service is enabled
        └ automaticbooleanIf true, all new uploaded items are send to label detection
        └ limitintegerMaximum number of detections
⟨⟩ range: 0 to 100000
    └ detectFacesobjectSettings regarding face detection
        └ servicestringService for face detection
≡ allowed values:
aws
        └ enabledbooleanIf true, service is enabled
        └ automaticbooleanIf true, all new uploaded items are send to face detection
        └ limitintegerMaximum number of detections
⟨⟩ range: 0 to 100000
        └ collectionIdstringId for the collection
    └ ocrobjectSettings regarding ocr
        └ servicestringService for ocr
≡ allowed values:
azure
        └ enabledbooleanIf true, service is enabled
        └ automaticbooleanIf true, all new uploaded items are send to ocr
        └ minConfidenceintegerConfidence level to activate OCR
⟨⟩ range: 0 to 100
    └ speechRecognitionobjectSettings regarding speechRecognition
        └ servicestringService for speechRecognition
≡ allowed values:
aws
        └ enabledbooleanIf true, service is enabled
        └ automaticbooleanIf true, all new uploaded items are send to speechRecognition
        └ limitintegerLimit for speechRecognition
⟨⟩ range: 0 to 100000
        └ defaultLanguagestringdefaultLanguage for speechRecognition
    └ translationobjectSettings regarding translation
        └ servicestringService for translation
≡ allowed values:
azuredeepl
        └ enabledbooleanIf true, service is enabled
        └ automaticbooleanIf true, all new uploaded items are send to translation
        └ limitintegerLimit for translation
⟨⟩ range: 0 to 100000
updatedAtdateTimeDate and time of the last update
Related Articles