Dropsite Controller

The Dropsite Controller manages dropsites within the AdmiralCloud platform. Dropsites are external upload portals that allow third parties — such as agencies, partners, or freelancers — to securely deliver files into your AdmiralCloud account without requiring a user account.

Key Features

Secure External Uploads: Provide branded upload portals to external contributors without granting them platform access
Targeted Ingestion: Route incoming files into a defined security groups for structured collection and downstream processing
Access Controls: Configure authentication, expiration, and usage limits to govern who can upload and for how long
Template-Based Design: Reuse dropsite templates for consistent branding and behavior across multiple campaigns or partners
Workflow Integration: Trigger notifications and follow-up workflows automatically once files are received

Dropsites streamline the collection of external media assets while keeping uploads governed, traceable, and aligned with your platform setup.

Reference

Dropsite find

GET/v5/dropsite/:mediaContainerId

IAM Permissions

Felder

customer.manageSecuritySettings→securitySettings.authsecuritySettings.clientIdsecuritySettings.cnamesecuritySettings.ipWhiteListsecuritySettings.matchReferer

Finds an existing dropsites and its details.

Request Parameters

Field	Type	Required	Description
mediaContainerId	integer	✓	Id of the mediaContainer of the dropsite. This id can also be found in the origin parameter of mediacontainers created by this dropsite.
refresh	boolean	✗	Fetch data fresh from database

Response

Field	Type	Description
availableSettings	array	Array of available settings for this dropsite Deprecated
connectedChannels	array	Array of channel IDs to connect to this dropsite
└ publicAreaId	integer	Mediahub ID to connect to
└ channels	array	Ids of channels to connect to
connectedPublicAreas	array	Array of public area IDs to connect to this dropsite
countUploads	integer	TBA
createdAt	datetime	Timestamp when this dropsite was created
creatorId	integer	User id of the creator of this dropsite
customerId	string	Currently HashIds – switch to base64!
end	integer	End time of this dropsite (invalid after end)
id	integer	Id of this dropsite
link	string	Link of the corresponding dropsite
maxAllowedUploads	integer	Maximum number of allowed uploads (mediacontainers). Defaults to unlimited.
mediaContainerId	integer	Id of the mediaContainer of the dropsite. This id can also be found in the origin parameter of mediacontainers created by this dropsite.
mediaContainerIds	array	Array of ids related (uploaded) to this dropsite
publish	boolean	If set to true, this dropsite is available externally. Defaults to true if you create a new dropsite
securitySettings	object	Security settings for this dropsite We are currently re-structuring and improving the security settings and would like to avoid breaking changes. Please contact AC support if you want to use or update security settings.
└ auth	object	customer.manageSecuritySettings
└ enabled	boolean	Enable authentication for this playerConfiguration
└ extAuth	object	External authentication configuration
└ enabled	boolean	Set to true to enable extAuth.
└ allowedAccessKeys	array	Array of accessKeys for extAuth
└ oauth	object	OAuth configuration for securing media access
└ enabled	boolean	Enable OAuth
└ clientId	string	Allowed clientId for OAuth
└ grants	array	Allowed grant types for OAuth (deprecated) Deprecated ≡ allowed values: cookie
└ ipWhiteList	object	IP allowlist configuration
└ enabled	boolean	Enable IP allowlist for this playerConfiguration
└ authOnly	boolean	If true, IP allowlist applies only to authenticated requests
└ clientId	string	Client ID for this dropsite customer.manageSecuritySettings
└ cname	fqdn	Custom domain name (FQDN) for this dropsite customer.manageSecuritySettings
└ ipWhiteList	cidr	Array of objects with keys cidr and type ("ipv4", "ipv6") with list of allowed CIDRs. customer.manageSecuritySettings
└ matchReferer	array	Deprecated customer.manageSecuritySettings
└ password	string	Optional password. If set a username must be set too.
└ username	string	Optional username. If set a password must be set too.
settings	object	Settings for this dropsite Please contact AC support if you want to use settings – we are currently re-structuring and improving the settings object and would like to avoid breaking changes.
└ allowedExtensionsForUpload	array	Array/list of file extensions which are allowed to upload via this dropsite (e.g. ["jpg","jpeg","tiff"]) ≡ allowed values: 3g23gp3gp23gppaaaacaaxaddinadtadtsaiaifaifcaiffapplicationasaxascxasfashxasmxaspxasxauavibmpbtappbtinstallbtkeybtsearchbtskincatcdcerconfigcontactcrlcrtcscsprojcsscsvdatasourcederdibdlldocdocmdocxdotdotmdotxdtddtsconfigepsexefdffifgifgrouphddhqxhtahtchtmhtmlhxahxchxdhxehxfhxhhxihxkhxqhxrhxshxthxvhxwicoicsipaipgipswiqyissiteitlpitlsitmsitpcjfifjnlpjpejpegjpgjslatexlibrary-msm1vm2tm2tsm2vm3um3u8m4am4bm4pm4rm4vmagnetmanmastermhtmhtmlmidmidimodmovmp2mp2vmp3mp4mp4vmpampempegmpfmpgmpv2mtsodcodgodmodpodsodtotgothotsottovaovfoxtp10p12p7bp7cp7mp7rp7spcastpdfpdfxmlpdxpfxpkoplspngpotpotmpotxppappamppsppsmppsxpptpptmpptxprfpspsc1pwzpypywratrcrc2rctrdlcresxrmirmprqyrtfsctsettingsshtmlsitsitemapskinsldmsldxslkslnslupkg-mssndsnippetspcsststcstdstlstwsvgsxcsxdsxgsxwtgathmxtiftifftorrenttsttstxtuservbvboxvbox-extpackvbprojvcfvdivdpvdprojvhdvmdkvorvscontentvsivspolicyvspolicydefvspsccvssccvssettingsvsssccvstemplatevstowalwavwavewaxwbkwdpwebmwebsitewizwlzwmwmawmdwmvwmxwmzwplwscwsdlwszwvxxamlxbapxdpxdrxfdfxhtxhtmlxlaxlamxldxlkxllxlmxlsxlsbxlsmxlsxxltxltmxltxxlwxmlxrm-msxscxsdxslxsltxss
└ allowedMediaContainerTypes	array	An array of allowed mediacontainer types (video, audio, etc). If not set, falls back to default config ["video","audio","image"]. ≡ allowed values: videoaudioimagedocument
└ allowedMetaLanguages	array	Array of allowed metadata languages. If not set, falls back to the customer.contractConfiguration.availableUIlanguages or ["de","en"]. ≡ allowed values: deendanlsv
└ createDownloadLink	object	Configuration for auto-creating a download link on upload
└ language	string	Language for the download link notification email ≡ allowed values: deen
└ formatIds	array	Array of format IDs to include in the download link
└ templateId	integer	Template ID for the download link email
└ receiver	array	Array of email recipients
└ type	string	Recipient type ≡ allowed values: toccbcc
└ recipient	email	Email address of the recipient
└ createWebLink	object	Auto-creates a weblink for any uploaded mediacontainer.
└ playerConfigurationIds	array	Array of player configuration IDs to use for the web link
└ templateId	integer	Template ID for the web link notification email
└ receiver	array	Array of email recipients
└ type	string	Recipient type ≡ allowed values: toccbcc
└ recipient	email	Email address of the recipient
└ name	string	Optional display name of the recipient
└ dialogueBox	object	Data for popup disclaimer modal
└ settings	object
└ enabled	boolean	Enable the popup disclaimer modal
└ body	object
└ rawContent	object	Raw content of the dialogue box body
└ checkbox	object	Checkbox configuration for the dialogue box
└ buttonLabel	object	Button label per language
└ en	string	Button label in English
└ de	string	Button label in German
└ documentRequired	boolean	If true, the user is required to send a document with the dropsite upload.
└ metadataFields	array	An array of objects defining the metadata fields to display (or make editable) at the dropsite.
└ title	string	Name of the field as used in the database
└ required	boolean	Legacy: whether this metadata field is required
└ isRequired	boolean	Whether this metadata field is required
└ notification	object	Notification settings for this dropsite. Beta
└ language	string	Language for the notification email ≡ allowed values: deen
└ receiver	array	Array of email recipients
└ type	string	Recipient type ≡ allowed values: toccbcc
└ recipient	email	Email address of the recipient
└ notifications	object	Extended notification configuration for uploads
└ enabled	boolean	Enable upload notifications
└ receiver	array	Array of email recipients
└ type	string	Recipient type ≡ allowed values: toccbcc
└ recipient	email	Email address of the recipient
└ publishToChannel	object
└ enabled	boolean	Enable publishing notification to channel
└ receiver	array	Array of channel IDs to publish notifications to
└ requiredMetadataLanguages	array	Language list for metadata fields for user to fill-in for upload to DS ≡ allowed values: deenfresnlsvda
└ displayDropsiteMetadata	array	An array of metadata titles to display on the dropsite. If not set, falls back to default config ["container_name", "container_description"].
start	integer	Start time of this dropsite (valid after start). If not set, defaults to current time.
templateId	integer	Optional templateId for this dropsite. If not set, defaults to basic template (4).
updatedAt	datetime	Timestamp when this dropsite was last updated

Examples

Find dropsite

Request

/v5/dropsite/:mediaContainerId

Response

{
    "body": {
        "link": "https:\/\/dropsite.admiralcloud.com\/zHfieF7AgDNQH",
        "maxAllowedUploads": 100,
        "countUploads": 10,
        "publish": true,
        "username": "dropsiteAccess",
        "password": "myVeryStrongPassword",
        "mediaContainerId": 6783,
        "customerId": 147,
        "creatorId": 2385,
        "id": 22,
        "createdAt": "2015-04-25T09:55:10.000Z",
        "updatedAt": "2015-04-25T11:48:35.000Z",
        "mediaContainerIds": [
            124,
            155,
            167
        ]
    }
}

Dropsite create

POST/v5/dropsite

IAM Permissions

Felder

customer.manageSecuritySettings→securitySettings.authsecuritySettings.clientIdsecuritySettings.cnamesecuritySettings.ipWhiteListsecuritySettings.matchReferer

Creates a dropsite for uploads without login. To connect contacts (uploader, internal contact) with the dropsite, please use the Contact.createRelation method.

Request Parameters

Field	Type	Required	Description
connectedChannels	array	✗	Array of channel IDs to connect to this dropsite
└ publicAreaId	integer	✓	Mediahub ID to connect to
└ channels	array	✓	Ids of channels to connect to
connectedPublicAreas	array	✗	Array of public area IDs to connect to this dropsite
end	integer	✗	End time of this dropsite (invalid after end)
flag	integer	✗	Flag for this record (0 = active)
maxAllowedUploads	integer	✗	Maximum number of allowed uploads (mediacontainers). Defaults to unlimited.
mediaContainerId	integer	✓	Id of the mediaContainer of the dropsite. This id can also be found in the origin parameter of mediacontainers created by this dropsite.
publish	boolean	✗	If set to true, this dropsite is available externally. Defaults to true if you create a new dropsite
securitySettings	object	✗	Security settings for this dropsite We are currently re-structuring and improving the security settings and would like to avoid breaking changes. Please contact AC support if you want to use or update security settings.
└ auth	object	✗	customer.manageSecuritySettings
└ enabled	boolean	✗	Enable authentication for this playerConfiguration
└ extAuth	object	✗	External authentication configuration
└ enabled	boolean	✗	Set to true to enable extAuth.
└ allowedAccessKeys	array	✓	Array of accessKeys for extAuth
└ oauth	object	✗	OAuth configuration for securing media access
└ enabled	boolean	✓	Enable OAuth
└ clientId	string	✓	Allowed clientId for OAuth
└ grants	array	✗	Allowed grant types for OAuth (deprecated) Deprecated ≡ allowed values: cookie
└ ipWhiteList	object	✗	IP allowlist configuration
└ enabled	boolean	✗	Enable IP allowlist for this playerConfiguration
└ authOnly	boolean	✓	If true, IP allowlist applies only to authenticated requests
└ clientId	string	✗	Client ID for this dropsite customer.manageSecuritySettings
└ cname	fqdn	✗	Custom domain name (FQDN) for this dropsite customer.manageSecuritySettings
└ ipWhiteList	cidr	✗	Array of objects with keys cidr and type ("ipv4", "ipv6") with list of allowed CIDRs. customer.manageSecuritySettings
└ matchReferer	array	✗	Deprecated customer.manageSecuritySettings
└ password	string	✗	Optional password. If set a username must be set too.
└ username	string	✗	Optional username. If set a password must be set too.
settings	object	✗	Settings for this dropsite Please contact AC support if you want to use settings – we are currently re-structuring and improving the settings object and would like to avoid breaking changes.
└ allowedExtensionsForUpload	array	✗	Array/list of file extensions which are allowed to upload via this dropsite (e.g. ["jpg","jpeg","tiff"]) ≡ allowed values: 3g23gp3gp23gppaaaacaaxaddinadtadtsaiaifaifcaiffapplicationasaxascxasfashxasmxaspxasxauavibmpbtappbtinstallbtkeybtsearchbtskincatcdcerconfigcontactcrlcrtcscsprojcsscsvdatasourcederdibdlldocdocmdocxdotdotmdotxdtddtsconfigepsexefdffifgifgrouphddhqxhtahtchtmhtmlhxahxchxdhxehxfhxhhxihxkhxqhxrhxshxthxvhxwicoicsipaipgipswiqyissiteitlpitlsitmsitpcjfifjnlpjpejpegjpgjslatexlibrary-msm1vm2tm2tsm2vm3um3u8m4am4bm4pm4rm4vmagnetmanmastermhtmhtmlmidmidimodmovmp2mp2vmp3mp4mp4vmpampempegmpfmpgmpv2mtsodcodgodmodpodsodtotgothotsottovaovfoxtp10p12p7bp7cp7mp7rp7spcastpdfpdfxmlpdxpfxpkoplspngpotpotmpotxppappamppsppsmppsxpptpptmpptxprfpspsc1pwzpypywratrcrc2rctrdlcresxrmirmprqyrtfsctsettingsshtmlsitsitemapskinsldmsldxslkslnslupkg-mssndsnippetspcsststcstdstlstwsvgsxcsxdsxgsxwtgathmxtiftifftorrenttsttstxtuservbvboxvbox-extpackvbprojvcfvdivdpvdprojvhdvmdkvorvscontentvsivspolicyvspolicydefvspsccvssccvssettingsvsssccvstemplatevstowalwavwavewaxwbkwdpwebmwebsitewizwlzwmwmawmdwmvwmxwmzwplwscwsdlwszwvxxamlxbapxdpxdrxfdfxhtxhtmlxlaxlamxldxlkxllxlmxlsxlsbxlsmxlsxxltxltmxltxxlwxmlxrm-msxscxsdxslxsltxss
└ allowedMediaContainerTypes	array	✗	An array of allowed mediacontainer types (video, audio, etc). If not set, falls back to default config ["video","audio","image"]. ≡ allowed values: videoaudioimagedocument
└ allowedMetaLanguages	array	✗	Array of allowed metadata languages. If not set, falls back to the customer.contractConfiguration.availableUIlanguages or ["de","en"]. ≡ allowed values: deendanlsv
└ createDownloadLink	object	✗	Configuration for auto-creating a download link on upload
└ language	string	✗	Language for the download link notification email ≡ allowed values: deen
└ formatIds	array	✗	Array of format IDs to include in the download link
└ templateId	integer	✗	Template ID for the download link email
└ receiver	array	✗	Array of email recipients
└ type	string	✗	Recipient type ≡ allowed values: toccbcc
└ recipient	email	✗	Email address of the recipient
└ createWebLink	object	✗	Auto-creates a weblink for any uploaded mediacontainer.
└ playerConfigurationIds	array	✗	Array of player configuration IDs to use for the web link
└ templateId	integer	✗	Template ID for the web link notification email
└ receiver	array	✗	Array of email recipients
└ type	string	✗	Recipient type ≡ allowed values: toccbcc
└ recipient	email	✗	Email address of the recipient
└ name	string	✗	Optional display name of the recipient
└ dialogueBox	object	✗	Data for popup disclaimer modal
└ settings	object	✗
└ enabled	boolean	✗	Enable the popup disclaimer modal
└ body	object	✗
└ rawContent	object	✗	Raw content of the dialogue box body
└ checkbox	object	✗	Checkbox configuration for the dialogue box
└ buttonLabel	object	✗	Button label per language
└ en	string	✗	Button label in English
└ de	string	✗	Button label in German
└ documentRequired	boolean	✗	If true, the user is required to send a document with the dropsite upload.
└ metadataFields	array	✗	An array of objects defining the metadata fields to display (or make editable) at the dropsite.
└ title	string	✗	Name of the field as used in the database
└ required	boolean	✗	Legacy: whether this metadata field is required
└ isRequired	boolean	✗	Whether this metadata field is required
└ notification	object	✗	Notification settings for this dropsite. Beta
└ language	string	✗	Language for the notification email ≡ allowed values: deen
└ receiver	array	✗	Array of email recipients
└ type	string	✗	Recipient type ≡ allowed values: toccbcc
└ recipient	email	✗	Email address of the recipient
└ notifications	object	✗	Extended notification configuration for uploads
└ enabled	boolean	✗	Enable upload notifications
└ receiver	array	✗	Array of email recipients
└ type	string	✗	Recipient type ≡ allowed values: toccbcc
└ recipient	email	✗	Email address of the recipient
└ publishToChannel	object	✗
└ enabled	boolean	✗	Enable publishing notification to channel
└ receiver	array	✗	Array of channel IDs to publish notifications to
└ requiredMetadataLanguages	array	✗	Language list for metadata fields for user to fill-in for upload to DS ≡ allowed values: deenfresnlsvda
└ displayDropsiteMetadata	array	✗	An array of metadata titles to display on the dropsite. If not set, falls back to default config ["container_name", "container_description"].
start	integer	✗	Start time of this dropsite (valid after start). If not set, defaults to current time.
templateId	integer	✗	Optional templateId for this dropsite. If not set, defaults to basic template (4).

Response

Field	Type	Description
availableSettings	array	Array of available settings for this dropsite Deprecated
connectedChannels	array	Array of channel IDs to connect to this dropsite
└ publicAreaId	integer	Mediahub ID to connect to
└ channels	array	Ids of channels to connect to
connectedPublicAreas	array	Array of public area IDs to connect to this dropsite
countUploads	integer	TBA
createdAt	datetime	Timestamp when this dropsite was created
creatorId	integer	User id of the creator of this dropsite
customerId	string	Currently HashIds – switch to base64!
end	integer	End time of this dropsite (invalid after end)
id	integer	Id of this dropsite
link	string	Link of the corresponding dropsite
maxAllowedUploads	integer	Maximum number of allowed uploads (mediacontainers). Defaults to unlimited.
mediaContainerId	integer	Id of the mediaContainer of the dropsite. This id can also be found in the origin parameter of mediacontainers created by this dropsite.
mediaContainerIds	array	Array of ids related (uploaded) to this dropsite
publish	boolean	If set to true, this dropsite is available externally. Defaults to true if you create a new dropsite
securitySettings	object	Security settings for this dropsite We are currently re-structuring and improving the security settings and would like to avoid breaking changes. Please contact AC support if you want to use or update security settings.
└ auth	object	customer.manageSecuritySettings
└ enabled	boolean	Enable authentication for this playerConfiguration
└ extAuth	object	External authentication configuration
└ enabled	boolean	Set to true to enable extAuth.
└ allowedAccessKeys	array	Array of accessKeys for extAuth
└ oauth	object	OAuth configuration for securing media access
└ enabled	boolean	Enable OAuth
└ clientId	string	Allowed clientId for OAuth
└ grants	array	Allowed grant types for OAuth (deprecated) Deprecated ≡ allowed values: cookie
└ ipWhiteList	object	IP allowlist configuration
└ enabled	boolean	Enable IP allowlist for this playerConfiguration
└ authOnly	boolean	If true, IP allowlist applies only to authenticated requests
└ clientId	string	Client ID for this dropsite customer.manageSecuritySettings
└ cname	fqdn	Custom domain name (FQDN) for this dropsite customer.manageSecuritySettings
└ ipWhiteList	cidr	Array of objects with keys cidr and type ("ipv4", "ipv6") with list of allowed CIDRs. customer.manageSecuritySettings
└ matchReferer	array	Deprecated customer.manageSecuritySettings
└ password	string	Optional password. If set a username must be set too.
└ username	string	Optional username. If set a password must be set too.
settings	object	Settings for this dropsite Please contact AC support if you want to use settings – we are currently re-structuring and improving the settings object and would like to avoid breaking changes.
└ allowedExtensionsForUpload	array	Array/list of file extensions which are allowed to upload via this dropsite (e.g. ["jpg","jpeg","tiff"]) ≡ allowed values: 3g23gp3gp23gppaaaacaaxaddinadtadtsaiaifaifcaiffapplicationasaxascxasfashxasmxaspxasxauavibmpbtappbtinstallbtkeybtsearchbtskincatcdcerconfigcontactcrlcrtcscsprojcsscsvdatasourcederdibdlldocdocmdocxdotdotmdotxdtddtsconfigepsexefdffifgifgrouphddhqxhtahtchtmhtmlhxahxchxdhxehxfhxhhxihxkhxqhxrhxshxthxvhxwicoicsipaipgipswiqyissiteitlpitlsitmsitpcjfifjnlpjpejpegjpgjslatexlibrary-msm1vm2tm2tsm2vm3um3u8m4am4bm4pm4rm4vmagnetmanmastermhtmhtmlmidmidimodmovmp2mp2vmp3mp4mp4vmpampempegmpfmpgmpv2mtsodcodgodmodpodsodtotgothotsottovaovfoxtp10p12p7bp7cp7mp7rp7spcastpdfpdfxmlpdxpfxpkoplspngpotpotmpotxppappamppsppsmppsxpptpptmpptxprfpspsc1pwzpypywratrcrc2rctrdlcresxrmirmprqyrtfsctsettingsshtmlsitsitemapskinsldmsldxslkslnslupkg-mssndsnippetspcsststcstdstlstwsvgsxcsxdsxgsxwtgathmxtiftifftorrenttsttstxtuservbvboxvbox-extpackvbprojvcfvdivdpvdprojvhdvmdkvorvscontentvsivspolicyvspolicydefvspsccvssccvssettingsvsssccvstemplatevstowalwavwavewaxwbkwdpwebmwebsitewizwlzwmwmawmdwmvwmxwmzwplwscwsdlwszwvxxamlxbapxdpxdrxfdfxhtxhtmlxlaxlamxldxlkxllxlmxlsxlsbxlsmxlsxxltxltmxltxxlwxmlxrm-msxscxsdxslxsltxss
└ allowedMediaContainerTypes	array	An array of allowed mediacontainer types (video, audio, etc). If not set, falls back to default config ["video","audio","image"]. ≡ allowed values: videoaudioimagedocument
└ allowedMetaLanguages	array	Array of allowed metadata languages. If not set, falls back to the customer.contractConfiguration.availableUIlanguages or ["de","en"]. ≡ allowed values: deendanlsv
└ createDownloadLink	object	Configuration for auto-creating a download link on upload
└ language	string	Language for the download link notification email ≡ allowed values: deen
└ formatIds	array	Array of format IDs to include in the download link
└ templateId	integer	Template ID for the download link email
└ receiver	array	Array of email recipients
└ type	string	Recipient type ≡ allowed values: toccbcc
└ recipient	email	Email address of the recipient
└ createWebLink	object	Auto-creates a weblink for any uploaded mediacontainer.
└ playerConfigurationIds	array	Array of player configuration IDs to use for the web link
└ templateId	integer	Template ID for the web link notification email
└ receiver	array	Array of email recipients
└ type	string	Recipient type ≡ allowed values: toccbcc
└ recipient	email	Email address of the recipient
└ name	string	Optional display name of the recipient
└ dialogueBox	object	Data for popup disclaimer modal
└ settings	object
└ enabled	boolean	Enable the popup disclaimer modal
└ body	object
└ rawContent	object	Raw content of the dialogue box body
└ checkbox	object	Checkbox configuration for the dialogue box
└ buttonLabel	object	Button label per language
└ en	string	Button label in English
└ de	string	Button label in German
└ documentRequired	boolean	If true, the user is required to send a document with the dropsite upload.
└ metadataFields	array	An array of objects defining the metadata fields to display (or make editable) at the dropsite.
└ title	string	Name of the field as used in the database
└ required	boolean	Legacy: whether this metadata field is required
└ isRequired	boolean	Whether this metadata field is required
└ notification	object	Notification settings for this dropsite. Beta
└ language	string	Language for the notification email ≡ allowed values: deen
└ receiver	array	Array of email recipients
└ type	string	Recipient type ≡ allowed values: toccbcc
└ recipient	email	Email address of the recipient
└ notifications	object	Extended notification configuration for uploads
└ enabled	boolean	Enable upload notifications
└ receiver	array	Array of email recipients
└ type	string	Recipient type ≡ allowed values: toccbcc
└ recipient	email	Email address of the recipient
└ publishToChannel	object
└ enabled	boolean	Enable publishing notification to channel
└ receiver	array	Array of channel IDs to publish notifications to
└ requiredMetadataLanguages	array	Language list for metadata fields for user to fill-in for upload to DS ≡ allowed values: deenfresnlsvda
└ displayDropsiteMetadata	array	An array of metadata titles to display on the dropsite. If not set, falls back to default config ["container_name", "container_description"].
start	integer	Start time of this dropsite (valid after start). If not set, defaults to current time.
templateId	integer	Optional templateId for this dropsite. If not set, defaults to basic template (4).
updatedAt	datetime	Timestamp when this dropsite was last updated

Examples

Single Upload

Request

/v5/dropsite

Response

{
    "body": {
        "link": "https:\/\/dropsite.admiralcloud.com\/zHfieF7AgDNQH",
        "mediaContainerId": 12052,
        "flag": 0,
        "templateId": 24,
        "maxAllowedUploads": 100,
        "countUploads": 10,
        "publish": true,
        "username": "dropsiteAccess",
        "password": "myVeryStrongPassword",
        "settings": [],
        "customerId": 147,
        "creatorId": 123,
        "createdAt": "2016-02-08T08:21:12.254Z",
        "updatedAt": "2016-02-08T08:21:12.254Z",
        "id": 218
    }
}

With Notification (BETA)

Request

/v5/dropsite

Response

With automatic embedlink creation

Request

/v5/dropsite

Response

Dropsite update

PUT/v5/dropsite/:mediaContainerId/:id

IAM Permissions

Felder

customer.manageSecuritySettings→securitySettings.authsecuritySettings.clientIdsecuritySettings.cnamesecuritySettings.ipWhiteListsecuritySettings.matchReferer

Updates a dropsite.

Request Parameters

Field	Type	Required	Description
connectedChannels	array	✗	Array of channel IDs to connect to this dropsite
└ publicAreaId	integer	✓	Mediahub ID to connect to
└ channels	array	✓	Ids of channels to connect to
connectedPublicAreas	array	✗	Array of public area IDs to connect to this dropsite
end	integer	✗	End time of this dropsite (invalid after end)
maxAllowedUploads	integer	✗	Maximum number of allowed uploads (mediacontainers). Defaults to unlimited.
mediaContainerId	integer	✓	Id of the mediaContainer of the dropsite. This id can also be found in the origin parameter of mediacontainers created by this dropsite.
publish	boolean	✗	If set to true, this dropsite is available externally. Defaults to true if you create a new dropsite
securitySettings	object	✗	Security settings for this dropsite We are currently re-structuring and improving the security settings and would like to avoid breaking changes. Please contact AC support if you want to use or update security settings.
└ auth	object	✗	customer.manageSecuritySettings
└ enabled	boolean	✗	Enable authentication for this playerConfiguration
└ extAuth	object	✗	External authentication configuration
└ enabled	boolean	✗	Set to true to enable extAuth.
└ allowedAccessKeys	array	✓	Array of accessKeys for extAuth
└ oauth	object	✗	OAuth configuration for securing media access
└ enabled	boolean	✓	Enable OAuth
└ clientId	string	✓	Allowed clientId for OAuth
└ grants	array	✗	Allowed grant types for OAuth (deprecated) Deprecated ≡ allowed values: cookie
└ ipWhiteList	object	✗	IP allowlist configuration
└ enabled	boolean	✗	Enable IP allowlist for this playerConfiguration
└ authOnly	boolean	✓	If true, IP allowlist applies only to authenticated requests
└ clientId	string	✗	Client ID for this dropsite customer.manageSecuritySettings
└ cname	fqdn	✗	Custom domain name (FQDN) for this dropsite customer.manageSecuritySettings
└ ipWhiteList	cidr	✗	Array of objects with keys cidr and type ("ipv4", "ipv6") with list of allowed CIDRs. customer.manageSecuritySettings
└ matchReferer	array	✗	Deprecated customer.manageSecuritySettings
└ password	string	✗	Optional password. If set a username must be set too.
└ username	string	✗	Optional username. If set a password must be set too.
settings	object	✗	Settings for this dropsite Please contact AC support if you want to use settings – we are currently re-structuring and improving the settings object and would like to avoid breaking changes.
└ allowedExtensionsForUpload	array	✗	Array/list of file extensions which are allowed to upload via this dropsite (e.g. ["jpg","jpeg","tiff"]) ≡ allowed values: 3g23gp3gp23gppaaaacaaxaddinadtadtsaiaifaifcaiffapplicationasaxascxasfashxasmxaspxasxauavibmpbtappbtinstallbtkeybtsearchbtskincatcdcerconfigcontactcrlcrtcscsprojcsscsvdatasourcederdibdlldocdocmdocxdotdotmdotxdtddtsconfigepsexefdffifgifgrouphddhqxhtahtchtmhtmlhxahxchxdhxehxfhxhhxihxkhxqhxrhxshxthxvhxwicoicsipaipgipswiqyissiteitlpitlsitmsitpcjfifjnlpjpejpegjpgjslatexlibrary-msm1vm2tm2tsm2vm3um3u8m4am4bm4pm4rm4vmagnetmanmastermhtmhtmlmidmidimodmovmp2mp2vmp3mp4mp4vmpampempegmpfmpgmpv2mtsodcodgodmodpodsodtotgothotsottovaovfoxtp10p12p7bp7cp7mp7rp7spcastpdfpdfxmlpdxpfxpkoplspngpotpotmpotxppappamppsppsmppsxpptpptmpptxprfpspsc1pwzpypywratrcrc2rctrdlcresxrmirmprqyrtfsctsettingsshtmlsitsitemapskinsldmsldxslkslnslupkg-mssndsnippetspcsststcstdstlstwsvgsxcsxdsxgsxwtgathmxtiftifftorrenttsttstxtuservbvboxvbox-extpackvbprojvcfvdivdpvdprojvhdvmdkvorvscontentvsivspolicyvspolicydefvspsccvssccvssettingsvsssccvstemplatevstowalwavwavewaxwbkwdpwebmwebsitewizwlzwmwmawmdwmvwmxwmzwplwscwsdlwszwvxxamlxbapxdpxdrxfdfxhtxhtmlxlaxlamxldxlkxllxlmxlsxlsbxlsmxlsxxltxltmxltxxlwxmlxrm-msxscxsdxslxsltxss
└ allowedMediaContainerTypes	array	✗	An array of allowed mediacontainer types (video, audio, etc). If not set, falls back to default config ["video","audio","image"]. ≡ allowed values: videoaudioimagedocument
└ allowedMetaLanguages	array	✗	Array of allowed metadata languages. If not set, falls back to the customer.contractConfiguration.availableUIlanguages or ["de","en"]. ≡ allowed values: deendanlsv
└ createDownloadLink	object	✗	Configuration for auto-creating a download link on upload
└ language	string	✗	Language for the download link notification email ≡ allowed values: deen
└ formatIds	array	✗	Array of format IDs to include in the download link
└ templateId	integer	✗	Template ID for the download link email
└ receiver	array	✗	Array of email recipients
└ type	string	✗	Recipient type ≡ allowed values: toccbcc
└ recipient	email	✗	Email address of the recipient
└ createWebLink	object	✗	Auto-creates a weblink for any uploaded mediacontainer.
└ playerConfigurationIds	array	✗	Array of player configuration IDs to use for the web link
└ templateId	integer	✗	Template ID for the web link notification email
└ receiver	array	✗	Array of email recipients
└ type	string	✗	Recipient type ≡ allowed values: toccbcc
└ recipient	email	✗	Email address of the recipient
└ name	string	✗	Optional display name of the recipient
└ dialogueBox	object	✗	Data for popup disclaimer modal
└ settings	object	✗
└ enabled	boolean	✗	Enable the popup disclaimer modal
└ body	object	✗
└ rawContent	object	✗	Raw content of the dialogue box body
└ checkbox	object	✗	Checkbox configuration for the dialogue box
└ buttonLabel	object	✗	Button label per language
└ en	string	✗	Button label in English
└ de	string	✗	Button label in German
└ documentRequired	boolean	✗	If true, the user is required to send a document with the dropsite upload.
└ metadataFields	array	✗	An array of objects defining the metadata fields to display (or make editable) at the dropsite.
└ title	string	✗	Name of the field as used in the database
└ required	boolean	✗	Legacy: whether this metadata field is required
└ isRequired	boolean	✗	Whether this metadata field is required
└ notification	object	✗	Notification settings for this dropsite. Beta
└ language	string	✗	Language for the notification email ≡ allowed values: deen
└ receiver	array	✗	Array of email recipients
└ type	string	✗	Recipient type ≡ allowed values: toccbcc
└ recipient	email	✗	Email address of the recipient
└ notifications	object	✗	Extended notification configuration for uploads
└ enabled	boolean	✗	Enable upload notifications
└ receiver	array	✗	Array of email recipients
└ type	string	✗	Recipient type ≡ allowed values: toccbcc
└ recipient	email	✗	Email address of the recipient
└ publishToChannel	object	✗
└ enabled	boolean	✗	Enable publishing notification to channel
└ receiver	array	✗	Array of channel IDs to publish notifications to
└ requiredMetadataLanguages	array	✗	Language list for metadata fields for user to fill-in for upload to DS ≡ allowed values: deenfresnlsvda
└ displayDropsiteMetadata	array	✗	An array of metadata titles to display on the dropsite. If not set, falls back to default config ["container_name", "container_description"].
start	integer	✗	Start time of this dropsite (valid after start). If not set, defaults to current time.
templateId	integer	✗	Optional templateId for this dropsite. If not set, defaults to basic template (4).

Response

Field	Type	Description
availableSettings	array	Array of available settings for this dropsite Deprecated
connectedChannels	array	Array of channel IDs to connect to this dropsite
└ publicAreaId	integer	Mediahub ID to connect to
└ channels	array	Ids of channels to connect to
connectedPublicAreas	array	Array of public area IDs to connect to this dropsite
countUploads	integer	TBA
createdAt	datetime	Timestamp when this dropsite was created
creatorId	integer	User id of the creator of this dropsite
customerId	string	Currently HashIds – switch to base64!
end	integer	End time of this dropsite (invalid after end)
id	integer	Id of this dropsite
link	string	Link of the corresponding dropsite
maxAllowedUploads	integer	Maximum number of allowed uploads (mediacontainers). Defaults to unlimited.
mediaContainerId	integer	Id of the mediaContainer of the dropsite. This id can also be found in the origin parameter of mediacontainers created by this dropsite.
mediaContainerIds	array	Array of ids related (uploaded) to this dropsite
publish	boolean	If set to true, this dropsite is available externally. Defaults to true if you create a new dropsite
securitySettings	object	Security settings for this dropsite We are currently re-structuring and improving the security settings and would like to avoid breaking changes. Please contact AC support if you want to use or update security settings.
└ auth	object	customer.manageSecuritySettings
└ enabled	boolean	Enable authentication for this playerConfiguration
└ extAuth	object	External authentication configuration
└ enabled	boolean	Set to true to enable extAuth.
└ allowedAccessKeys	array	Array of accessKeys for extAuth
└ oauth	object	OAuth configuration for securing media access
└ enabled	boolean	Enable OAuth
└ clientId	string	Allowed clientId for OAuth
└ grants	array	Allowed grant types for OAuth (deprecated) Deprecated ≡ allowed values: cookie
└ ipWhiteList	object	IP allowlist configuration
└ enabled	boolean	Enable IP allowlist for this playerConfiguration
└ authOnly	boolean	If true, IP allowlist applies only to authenticated requests
└ clientId	string	Client ID for this dropsite customer.manageSecuritySettings
└ cname	fqdn	Custom domain name (FQDN) for this dropsite customer.manageSecuritySettings
└ ipWhiteList	cidr	Array of objects with keys cidr and type ("ipv4", "ipv6") with list of allowed CIDRs. customer.manageSecuritySettings
└ matchReferer	array	Deprecated customer.manageSecuritySettings
└ password	string	Optional password. If set a username must be set too.
└ username	string	Optional username. If set a password must be set too.
settings	object	Settings for this dropsite Please contact AC support if you want to use settings – we are currently re-structuring and improving the settings object and would like to avoid breaking changes.
└ allowedExtensionsForUpload	array	Array/list of file extensions which are allowed to upload via this dropsite (e.g. ["jpg","jpeg","tiff"]) ≡ allowed values: 3g23gp3gp23gppaaaacaaxaddinadtadtsaiaifaifcaiffapplicationasaxascxasfashxasmxaspxasxauavibmpbtappbtinstallbtkeybtsearchbtskincatcdcerconfigcontactcrlcrtcscsprojcsscsvdatasourcederdibdlldocdocmdocxdotdotmdotxdtddtsconfigepsexefdffifgifgrouphddhqxhtahtchtmhtmlhxahxchxdhxehxfhxhhxihxkhxqhxrhxshxthxvhxwicoicsipaipgipswiqyissiteitlpitlsitmsitpcjfifjnlpjpejpegjpgjslatexlibrary-msm1vm2tm2tsm2vm3um3u8m4am4bm4pm4rm4vmagnetmanmastermhtmhtmlmidmidimodmovmp2mp2vmp3mp4mp4vmpampempegmpfmpgmpv2mtsodcodgodmodpodsodtotgothotsottovaovfoxtp10p12p7bp7cp7mp7rp7spcastpdfpdfxmlpdxpfxpkoplspngpotpotmpotxppappamppsppsmppsxpptpptmpptxprfpspsc1pwzpypywratrcrc2rctrdlcresxrmirmprqyrtfsctsettingsshtmlsitsitemapskinsldmsldxslkslnslupkg-mssndsnippetspcsststcstdstlstwsvgsxcsxdsxgsxwtgathmxtiftifftorrenttsttstxtuservbvboxvbox-extpackvbprojvcfvdivdpvdprojvhdvmdkvorvscontentvsivspolicyvspolicydefvspsccvssccvssettingsvsssccvstemplatevstowalwavwavewaxwbkwdpwebmwebsitewizwlzwmwmawmdwmvwmxwmzwplwscwsdlwszwvxxamlxbapxdpxdrxfdfxhtxhtmlxlaxlamxldxlkxllxlmxlsxlsbxlsmxlsxxltxltmxltxxlwxmlxrm-msxscxsdxslxsltxss
└ allowedMediaContainerTypes	array	An array of allowed mediacontainer types (video, audio, etc). If not set, falls back to default config ["video","audio","image"]. ≡ allowed values: videoaudioimagedocument
└ allowedMetaLanguages	array	Array of allowed metadata languages. If not set, falls back to the customer.contractConfiguration.availableUIlanguages or ["de","en"]. ≡ allowed values: deendanlsv
└ createDownloadLink	object	Configuration for auto-creating a download link on upload
└ language	string	Language for the download link notification email ≡ allowed values: deen
└ formatIds	array	Array of format IDs to include in the download link
└ templateId	integer	Template ID for the download link email
└ receiver	array	Array of email recipients
└ type	string	Recipient type ≡ allowed values: toccbcc
└ recipient	email	Email address of the recipient
└ createWebLink	object	Auto-creates a weblink for any uploaded mediacontainer.
└ playerConfigurationIds	array	Array of player configuration IDs to use for the web link
└ templateId	integer	Template ID for the web link notification email
└ receiver	array	Array of email recipients
└ type	string	Recipient type ≡ allowed values: toccbcc
└ recipient	email	Email address of the recipient
└ name	string	Optional display name of the recipient
└ dialogueBox	object	Data for popup disclaimer modal
└ settings	object
└ enabled	boolean	Enable the popup disclaimer modal
└ body	object
└ rawContent	object	Raw content of the dialogue box body
└ checkbox	object	Checkbox configuration for the dialogue box
└ buttonLabel	object	Button label per language
└ en	string	Button label in English
└ de	string	Button label in German
└ documentRequired	boolean	If true, the user is required to send a document with the dropsite upload.
└ metadataFields	array	An array of objects defining the metadata fields to display (or make editable) at the dropsite.
└ title	string	Name of the field as used in the database
└ required	boolean	Legacy: whether this metadata field is required
└ isRequired	boolean	Whether this metadata field is required
└ notification	object	Notification settings for this dropsite. Beta
└ language	string	Language for the notification email ≡ allowed values: deen
└ receiver	array	Array of email recipients
└ type	string	Recipient type ≡ allowed values: toccbcc
└ recipient	email	Email address of the recipient
└ notifications	object	Extended notification configuration for uploads
└ enabled	boolean	Enable upload notifications
└ receiver	array	Array of email recipients
└ type	string	Recipient type ≡ allowed values: toccbcc
└ recipient	email	Email address of the recipient
└ publishToChannel	object
└ enabled	boolean	Enable publishing notification to channel
└ receiver	array	Array of channel IDs to publish notifications to
└ requiredMetadataLanguages	array	Language list for metadata fields for user to fill-in for upload to DS ≡ allowed values: deenfresnlsvda
└ displayDropsiteMetadata	array	An array of metadata titles to display on the dropsite. If not set, falls back to default config ["container_name", "container_description"].
start	integer	Start time of this dropsite (valid after start). If not set, defaults to current time.
templateId	integer	Optional templateId for this dropsite. If not set, defaults to basic template (4).
updatedAt	datetime	Timestamp when this dropsite was last updated

Examples

Update settings

Request

/v5/dropsite

Response

{
    "body": {
        "link": "https:\/\/dropsite.admiralcloud.com\/zHfieF7AgDNQH",
        "flag": 0,
        "settings": {
            "allowedMediaContainerTypes": [
                "video"
            ],
            "metadataFields": [
                {
                    "title": "container_name",
                    "isRequired": true
                },
                {
                    "title": "meta_director",
                    "isRequired": false
                }
            ]
        },
        "maxAllowedUploads": 100,
        "countUploads": 10,
        "publish": true,
        "username": "dropsiteAccess",
        "password": "myVeryStrongPassword",
        "mediaContainerId": 192,
        "customerId": 144,
        "creatorId": 13,
        "id": 218,
        "createdAt": "2016-02-08T08:21:12.000Z",
        "updatedAt": "2016-02-08T08:58:00.000Z"
    }
}

Update – with automatic embedlink creation

Request

/v5/dropsite

Response

Dropsite destroy

DELETE/v5/dropsite/:mediaContainerId

Destroys a dropsite by flagging it to 1 and deleting the corresponding mediacontainer.

Request Parameters

Field	Type	Required	Description
mediaContainerId	integer	✓	Id of the mediaContainer of the dropsite. This id can also be found in the origin parameter of mediacontainers created by this dropsite.

Response

Field	Type	Description
id	integer	Id of this dropsite

Examples

Destroy dropsite

Request

/v5/dropsite/:mediaContainerId

Response

{
    "body": {
        "id": 12354
    }
}

API

Key Features

Reference

Dropsite find

Dropsite create

Dropsite update

Dropsite destroy

Related Articles