Domain Management
To use the Domain Management APIs, the calling Domain must be part the Partner Management Group of 3Q. Contact the Support, if this is needed.
/domains/clonefornetwork
POST https://api.nexx.cloud/v3.1/manage/domains/clonefornetwork
the Title of the new registered Domain
the URL of the new registered Domain
[mixed, master, own, all] defines the Rights on Network Contents for the new Domain
an internal Reference Number of the Client
/domains/:domainid/markfordeletion
DELETE https://api.nexx.cloud/v3.1/manage/domains/:domainid/markfordeletion
will mark the given Domain for Deletion. The given Domain cannot be the calling Domain and must be part of the same Network. Contents of the target Domain will not be deleted.
Path Parameters
a valid Domain ID of the Network of the calling Domain
Domain References
Domain References handles Objects and Structures, that are not considered as "Media", but belong to the Domain and serve as References.
POST https://api.nexx.cloud/v3.1/manage/channels/add
all Parameters of the /channels/update Methods are supported.
/channels/:channelid/update
PUT https://api.nexx.cloud/v3.1/manage/channels/:channelid/update
Path Parameters
the ID of a Channel of the calling Domain
if the Channel shall be a Sub Channel of a parent Channel, add the parent Channel ID here
an optional Sorting Parameter for publically visible Channels
/channels/:channelid/cover
POST https://api.nexx.cloud/v3.1/manage/channels/:channelid/cover
Path Parameters
the ID of a Channel of the calling Domain
Query Parameters
the URL to the Image, that should be used as Cover
an optional Description of the Cover
if the Domain supports MultiLanguage Assets, this Cover will be used only in Contexts with this given Language and not override the main Cover
an optional Copyright for the Cover
if set to 1, the System will assume, that this Asset has been created by an AI.
/channels/:channelid/actionshot
POST https://api.nexx.cloud/v3.1/manage/channels/actionshot
Path Parameters
the ID of a Channel of the calling Domain
Query Parameters
the URL to the Image, that should be used as ActionShot
an optional Description of the Cover
if the Domain supports MultiLanguage Assets, this Cover will be used only in Contexts with this given Language and not override the main Cover
an optional Copyright for the Cover.
if set to 1, the System will assume, that this Asset has been created by an AI.
/channels/:channelid/remove
DELETE https://api.nexx.cloud/v3.1/manage/channels/:channelid/remove
Path Parameters
the ID of a Channel of the calling Domain
POST https://api.nexx.cloud/v3.1/manage/formats/add
all Parameters of the /formats/update Methods are supported.
PUT https://api.nexx.cloud/v3.1/manage/formats/:formatid/update
Path Parameters
the ID of a Channel of the calling Domain
POST https://api.nexx.cloud/v3.1/manage/formats/:formatid/cover
Path Parameters
the ID of a Format of the calling Domain
Query Parameters
the URL to the Image, that should be used as Cover
an optional Description of the Cover
if the Domain supports MultiLanguage Assets, this Cover will be used only in Contexts with this given Language and not override the main Cover
an optional Copyright for the Cover.
if set to 1, the System will assume, that this Asset has been created by an AI.
POST https://api.nexx.cloud/v3.1/manage/formats/:formatid/actionshot
Path Parameters
the ID of a Format of the calling Domain
Query Parameters
the URL to the Image, that should be used as Cover
an optional Description of the Cover
if the Domain supports MultiLanguage Assets, this Cover will be used only in Contexts with this given Language and not override the main Cover
an optional Copyright for the Cover
if set to 1, the System will assume, that this Asset has been created by an AI.
DELETE https://api.nexx.cloud/v3.1/manage/formats/:formatid/remove
Path Parameters
the ID of a Channel of the calling Domain
/:streamtypecategories/add
POST https://api.nexx.cloud/v3.1/manage/:streamtypecategories/add
all Parameters of the /channels/update Methods are supported.
Path Parameters
[videocategories, audiocategories, imagecategories, filecategories, articlecategories, eventcategories, placecategories, productcategories]
/:streamtypecategories/:categoryid/update
PUT https://api.nexx.cloud/v3.1/manage/:streamtypecategories/:categoryid/update
Path Parameters
[videocategories, audiocategories, imagecategories, filecategories, articlecategories, eventcategories, placecategories, productcategories]
the ID of a Category of the given Type of the calling Domain
only valid for Event Categories
/:streamtypecategories/:categoryid/cover
POST https://api.nexx.cloud/v3.1/manage/:streamtypecategories/:categoryid/cover
Path Parameters
the ID of a Category of the given Type of the calling Domain
[videocategories, audiocategories, imagecategories, filecategories, articlecategories, eventcategories, placecategories, productcategories]
Query Parameters
the URL to the Image, that should be used as Cover
an optional Description of the Cover
if the Domain supports MultiLanguage Assets, this Cover will be used only in Contexts with this given Language and not override the main Cover
an optional Copyright of the Cover
/:streamtypecategories/:categoryid/remove
DELETE https://api.nexx.cloud/v3.1/manage/:streamtypecategories/:categoryid/remove
Path Parameters
[videocategories, audiocategories, imagecategories, filecategories, articlecategories, eventcategories, placecategories, productcategories]
the ID of a Category of the given Type of the calling Domain
UploadsLinks are dynamic URLs, that allow external Users to upload Files to a specific nexxOMNIA Account.
/uploadlinks/add
POST https://api.nexx.cloud/v3.1/manage/uploadlinks/add
a Title for the new UploadLink
a comma-seperated List of Streamtypes, that can be uploaded via this Link. Possible is [video, audio, image, file]
a 2-Letter coded Language for the Frontend. Currently supported is [de, en, es, fr]
if the UploadLink shall be restricted in Usage, use this Parameter for the maximal Number of Usages.
if desired, an optional code for further Protection of the Link.
if set to 1, the UploadLink UI will use the target Domain Colors and Icons.
if set to 1, the UploadLink will force the User to add some "Notes" as addiitonal Info for this Upload
/uploadlinks/:uploadlinkid/remove
DELETE https://api.nexx.cloud/v3.1/manage/uploadlinks/:uploadlinkid/remove
Path Parameters
the ID of an UploadLink of the calling Domain
