App Mgmt 26.06 ONVIF™ www.onvif.org June, 2026 2008-2026 ONVIF™ All rights reserved. Recipients of this document may copy, distribute, publish, or display this document so long as this copyright notice, license and disclaimer are retained with all copies of the document. No license is granted to modify this document. THIS DOCUMENT IS PROVIDED "AS IS," AND THE CORPORATION AND ITS MEMBERS AND THEIR AFFILIATES, MAKE NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO, WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, OR TITLE; THAT THE CONTENTS OF THIS DOCUMENT ARE SUITABLE FOR ANY PURPOSE; OR THAT THE IMPLEMENTATION OF SUCH CONTENTS WILL NOT INFRINGE ANY PATENTS, COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS. IN NO EVENT WILL THE CORPORATION OR ITS MEMBERS OR THEIR AFFILIATES BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL, INCIDENTAL, PUNITIVE OR CONSEQUENTIAL DAMAGES, ARISING OUT OF OR RELATING TO ANY USE OR DISTRIBUTION OF THIS DOCUMENT, WHETHER OR NOT (1) THE CORPORATION, MEMBERS OR THEIR AFFILIATES HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES, OR (2) SUCH DAMAGES WERE REASONABLY FORESEEABLE, AND ARISING OUT OF OR RELATING TO ANY USE OR DISTRIBUTION OF THIS DOCUMENT.  THE FOREGOING DISCLAIMER AND LIMITATION ON LIABILITY DO NOT APPLY TO, INVALIDATE, OR LIMIT REPRESENTATIONS AND WARRANTIES MADE BY THE MEMBERS AND THEIR RESPECTIVE AFFILIATES TO THE CORPORATION AND OTHER MEMBERS IN CERTAIN WRITTEN POLICIES OF THE CORPORATION. 19.12 Dec-2019 Hans Busch Initial release 21.06 Jun-2021 Hans Busch Update backup and restore. Add configuration URI. 21.12 Dec-2021 Fredrik Svensson Fix inconsistencies between appmgmt schema and doc. 22.06 Jun-2022 Sujith Raman Correct namespace of event State member. 22.12 Dec-2022 Sujith Raman Update Appmgmt app state enumeration. 26.06 Jun-2026 Ottavio Campana, José Mélançon Added the missing namespace definition, fix capabilities name. This document defines an interface for managing applications on a device. This specification focuses on the network interface for managing the application lifecycle on a device. It includes installation, information retrieval as well as controlling execution. The actual runtime environment as well as the application packaging format are out of scope of this specification. ONVIF Core Specification <> Docker Enterprise Application Container Platform < > Android < >

App Application that can be installed and executed on a networked device.

HTTP Hypertext Transfer Protocol TLS Transport Layer Security

A variety of standardized and proprietary application runtime formats exist. Examples for well-known standardized runtimes are Docker and Android. This specification provides network interface APIs based on the ONVIF Core Specification for uploading and controlling applications on a networked device. The following basic functionalities are defined by this specification: Installing and uninstalling of applications. Starting and stopping execution of applications. Enumeration of installed applications Listing of application details Enrolling application licenses An application state change event allows a client to retrieve and track application state changes without the need for polling. Note that both the container format as well as the runtime are outside of the scope of this specification. Prefix Namespace URI env http://www.w3.org/2003/05/soap-envelope ter http://www.onvif.org/ver10/error xs http://www.w3.org/2001/XMLSchema tt http://www.onvif.org/ver10/schema ans http://www.onvif.org/ver10/appmgmt/wsdl

Each application has an associated state. Possible states are Installing, Active, Inactive, DeInstalling and InstallationFailed. Clients can retrieve the application state via the GetAppInfo method or by subscribing to the application state property event. The latter mechanism allows retrieving the initial state as well as updates via property events.

Applications are deployed to a device via http POST to the URI provided by GetServiceCapabilities. The same URI shall be used for updating an application. A device supporting this service shall support the POST operation to the upload URI provided by the UploadPath capability. When posting an image to one of the URIs, the following HTML status codes may be returned, depending on success or failure: 200 OK Image file was successfully uploaded. 401 Unauthorized Attempted POST without authentication credentials at the WRITE_SYSTEM access policy level 408 Request Timeout POST took too long to upload 411 Length Required POST does not include Content-Length header 415 Unsupported Media Type POST does not include Content-Type header, or file MIME type does not match any type in the FormatsSupported attribute's list Note that the installation may not be completed when the upload has finished. If uploading succeeded, a device shall signal start of the installation via the state property event. If the installation fails, the device shall send a final InstallationFailed state. Otherwise the state shall change to either Active or Inactive.

For updates, a device shall support the same mechanism as the installation procedure defined in . In case an application is in state Active, the device shall change its state to Inactive before signaling installation state change events as stated in .

A device supporting this service shall support this method to stop and remove an installed application. request AppID – [xs:string] Application to be removed response <empty> faults env:Sender - ter:InvalidArgVal – ter:UnknownId The requested application ID does not exist. access class SYSTEM_WRITE

A device supporting this service shall support this method to start an installed application. request AppID – [xs:string] Application to be started response <empty> faults env:Sender - ter:InvalidArgVal – ter:UnknownId The requested application ID does not exist. access class SYSTEM_WRITE

A device supporting this service shall support this method to stop an installed application. request AppID – [xs:string] Application to be stopped response <empty> faults env:Sender - ter:InvalidArgVal – ter:UnknownId The requested application ID does not exist. access class SYSTEM_WRITE

A device signals support for backup and restore of individual applications by providing the Configuration URI in the application information items (see ). Clients can retrieve and backup the current configuration via the http GET method. Note that the configuration itself is an opaque blob. A backed-up configuration may be restored at a later time by uploading it to the device via the http POST method. Refer to the individual application documentation regarding support for restoring of configurations across devices and versions. For general error behavior of the restore function see . Additionally an application may generate the following error response 521 Version mismatch The application cannot restore the provided configuration.

A device should provide an interface description for applications providing a programming API for configuration and monitoring purposes. For these applications a device should provide a link via the InterfaceDescription information item as defined in . It allows clients to easily integrate application configuration and information retrieval. Examples for interface description languages are JSON or YAML descriptions according to OpenAPI.

The following items may be associated to each application and can be queried either via the GetInstalledApps method or the GetAppInfo method. AppID Unique identifier of an application Name User readable name of the application Version Version string assigned by the application vendor Licenses Licenses associated with the application Privileges Privileges assigned to the application InstallationDate Date when the application was installed LastUpdate Date when the application was last updated State Information whether the application is currently Installing, Active, Inactive or Uninstalling (see ). InstallationFailed state can be provided only in AppMgmt/State event. Status Textual description of the state. In error cases this shall contain the error reason. Autostart Indication whether the application automatically starts on system boot. Website Link to an internal or external website providing supplementary information about the application or its vendor. Configuration Optional Uri for backup and restore of the application configuration. InterfaceDescription Optional reference to the applications interface definition. OpenSource Optional link to a listing of related open source licenses.

A device supporting this service shall support this command to enumerate all installed applications. This method provides only high level information on the applications for more detailed information see GetAppInfo. request <empty> response App – optional, unbounded [Application] List of applications containing its ID as well as a user readable name. faults <none> access class SYSTEM_READ

A device supporting this service shall support this command to retrieve detailed information about applications. The caller may provide an application ID to retrieve the information for a single application. If no application ID is provided, the device shall report the information for all installed applications. request AppID – optional [xs:string] Optional ID to only retrieve information for a single application response Info – optional, unbounded [AppInfo] List of detailed information about the applications. faults env:Sender - ter:InvalidArgVal – ter:UnknownId The requested application ID does not exist. access class SYSTEM_READ

A device signaling support via the Licensing capability shall support this command to install a license on the device. The format and structure of the license string is outside of the scope of this specification. Refer to GetAppInfo for listing installed application licenses. request AppID – optional [xs:string] Application the license shall be associated to. License – [xs:string] Computer readable license string to be installed. response <empty> faults env:Sender - ter:InvalidArgVal – ter:InvalidFormat The device cannot interpret the license either because the format is unknown or because it has invalid syntax. access class SYSTEM_WRITE

The capabilities reflect optional functions and functionality of a service. The information is static and does not change during device operation. request This message is empty response Capabilities [Capabilities] Set of indicators for function groups as described above. faults None access class PRE_AUTH The following capabilities are available: UploadPath Mandatory upload URI for applications. Licensing Signals support for licensing of applications. FormatsSupported List of application formats supported by the device. EventTopicPrefix Optional Event Topic prefix used when delivering app events in eventservice.

Whenever the state of an application instance changes the following property event shall be generated. shows the possible states and their transitions. tns1:AppMgmt/State ]]> The Status item is optional. It shall be included whenever an error triggered the state change.

Based on an app's internal configuration (outside the scope of onvif), an app-generated event can be delivered either with a standard event topic or with a prefix like "tns1:{EventTopicPrefix}/{AppID}/{EventName}". For example, if EventTopicPrefix is notified as "AppEvent", AppID is "DetectorApp" and event name is "FaceDetection", then the topic would look like tns1:AppEvent/DetectorApp/FaceDetection. A client interested in events from an installed app can get the updated list of supported events from the event service "geteventproperties" api response whenever there is a change in the "tns1:AppMgmt/State" event.