API - Revision history

Burger: /* See Also */

2025-07-10T12:11:25Z

See Also

← Older revision		Revision as of 08:11, 10 July 2025
Line 172:		Line 172:
	* [[ZMNinja]]		* [[ZMNinja]]
	* [[External_Live_Stream]] - An example of using the API to show the camera streams in a webpage.		* [[External_Live_Stream]] - An example of using the API to show the camera streams in a webpage.
	* https://gist.github.com/connortechnology/9ca83f812d94b2777b93ad54ee45067e Example apache config		* https://gist.github.com/connortechnology/9ca83f812d94b2777b93ad54ee45067e - Example apache config
	* https://forums.zoneminder.com/viewtopic.php?p=137619#p137619 Embedding DB select in an API request.		* https://forums.zoneminder.com/viewtopic.php?p=137619#p137619 - Embedding DB select in an API request.

	[[Category:Dummies_Guide]]		[[Category:Dummies_Guide]]

Burger: /* See Also */

2025-07-10T12:11:14Z

See Also

← Older revision		Revision as of 08:11, 10 July 2025
Line 173:		Line 173:
	* [[External_Live_Stream]] - An example of using the API to show the camera streams in a webpage.		* [[External_Live_Stream]] - An example of using the API to show the camera streams in a webpage.
	* https://gist.github.com/connortechnology/9ca83f812d94b2777b93ad54ee45067e Example apache config		* https://gist.github.com/connortechnology/9ca83f812d94b2777b93ad54ee45067e Example apache config
			* https://forums.zoneminder.com/viewtopic.php?p=137619#p137619 Embedding DB select in an API request.

	[[Category:Dummies_Guide]]		[[Category:Dummies_Guide]]

Burger: /* Example Configuration for /etc/apache2/conf-enabled/zoneminder.conf */

2024-08-26T22:05:44Z

Example Configuration for /etc/apache2/conf-enabled/zoneminder.conf

← Older revision		Revision as of 18:05, 26 August 2024
Line 111:		Line 111:

	===Example Configuration for /etc/apache2/conf-enabled/zoneminder.conf===		===Example Configuration for /etc/apache2/conf-enabled/zoneminder.conf===
			See also the example in the github gist below. Although that one does not
			work for me, but the following one does.
	<pre>		<pre>
	# Remember to enable cgi mod (i.e. "a2enmod cgi").		# Remember to enable cgi mod (i.e. "a2enmod cgi").

Burger: /* curl -X GET http://serverip/zm/api/host/getVersion.json returns with 'page not found' */

2024-08-26T22:05:19Z

curl -X GET http://serverip/zm/api/host/getVersion.json returns with 'page not found'

@@ Line 109: / Line 109: @@
 ===curl -X GET http://serverip/zm/api/host/getVersion.json returns with 'page not found'===
 Check that you have an up to date copy of the /etc/apache2/conf-available/zoneminder.conf file. If in doubt, compare to a working installation. I recently had a case, where the zoneminder.conf file was missing some of the configurations (it must've been from migrating an older ZM to 1.36), it should be around 50+ lines of code for 1.36. Also make sure the appropriate apache modules are enabled (a2enmod rewrites, a2enmod cgi, and there are some others, see wiki.zoneminder.com/Debian).
 ==See Also==
 * [[ZMNinja]]

Burger: /* See Also */

2024-08-22T22:32:46Z

See Also

← Older revision		Revision as of 18:32, 22 August 2024
Line 112:		Line 112:
	* [[ZMNinja]]		* [[ZMNinja]]
	* [[External_Live_Stream]] - An example of using the API to show the camera streams in a webpage.		* [[External_Live_Stream]] - An example of using the API to show the camera streams in a webpage.
	* https://gist.github.com/connortechnology/9ca83f812d94b2777b93ad54ee45067e ~~Developer example~~ apache config		* https://gist.github.com/connortechnology/9ca83f812d94b2777b93ad54ee45067e Example apache config

	[[Category:Dummies_Guide]]		[[Category:Dummies_Guide]]

Burger: /* See Also */

2024-08-22T22:32:34Z

See Also

← Older revision		Revision as of 18:32, 22 August 2024
Line 112:		Line 112:
	* [[ZMNinja]]		* [[ZMNinja]]
	* [[External_Live_Stream]] - An example of using the API to show the camera streams in a webpage.		* [[External_Live_Stream]] - An example of using the API to show the camera streams in a webpage.
			* https://gist.github.com/connortechnology/9ca83f812d94b2777b93ad54ee45067e Developer example apache config

	[[Category:Dummies_Guide]]		[[Category:Dummies_Guide]]

Burger: /* Database Password Not Set in CakePHP */

2024-08-22T22:24:14Z

Database Password Not Set in CakePHP

← Older revision		Revision as of 18:24, 22 August 2024
Line 109:		Line 109:
	===curl -X GET http://serverip/zm/api/host/getVersion.json returns with 'page not found'===		===curl -X GET http://serverip/zm/api/host/getVersion.json returns with 'page not found'===
	Check that you have an up to date copy of the /etc/apache2/conf-available/zoneminder.conf file. If in doubt, compare to a working installation. I recently had a case, where the zoneminder.conf file was missing some of the configurations (it must've been from migrating an older ZM to 1.36), it should be around 50+ lines of code for 1.36. Also make sure the appropriate apache modules are enabled (a2enmod rewrites, a2enmod cgi, and there are some others, see wiki.zoneminder.com/Debian).		Check that you have an up to date copy of the /etc/apache2/conf-available/zoneminder.conf file. If in doubt, compare to a working installation. I recently had a case, where the zoneminder.conf file was missing some of the configurations (it must've been from migrating an older ZM to 1.36), it should be around 50+ lines of code for 1.36. Also make sure the appropriate apache modules are enabled (a2enmod rewrites, a2enmod cgi, and there are some others, see wiki.zoneminder.com/Debian).
	~~===Database Password Not Set in CakePHP===~~
	~~If you have a zmdb password that is not the standard zmuser / zmpass, it must be specified separately in CakePHP.~~

	==See Also==		==See Also==
	* [[ZMNinja]]		* [[ZMNinja]]

Burger: /* curl -X GET http://serverip/zm/api/host/getVersion.json returns with 'page not found' */

2024-08-22T22:19:49Z

curl -X GET http://serverip/zm/api/host/getVersion.json returns with 'page not found'

← Older revision		Revision as of 18:19, 22 August 2024
Line 109:		Line 109:
	===curl -X GET http://serverip/zm/api/host/getVersion.json returns with 'page not found'===		===curl -X GET http://serverip/zm/api/host/getVersion.json returns with 'page not found'===
	Check that you have an up to date copy of the /etc/apache2/conf-available/zoneminder.conf file. If in doubt, compare to a working installation. I recently had a case, where the zoneminder.conf file was missing some of the configurations (it must've been from migrating an older ZM to 1.36), it should be around 50+ lines of code for 1.36. Also make sure the appropriate apache modules are enabled (a2enmod rewrites, a2enmod cgi, and there are some others, see wiki.zoneminder.com/Debian).		Check that you have an up to date copy of the /etc/apache2/conf-available/zoneminder.conf file. If in doubt, compare to a working installation. I recently had a case, where the zoneminder.conf file was missing some of the configurations (it must've been from migrating an older ZM to 1.36), it should be around 50+ lines of code for 1.36. Also make sure the appropriate apache modules are enabled (a2enmod rewrites, a2enmod cgi, and there are some others, see wiki.zoneminder.com/Debian).
			===Database Password Not Set in CakePHP===
			If you have a zmdb password that is not the standard zmuser / zmpass, it must be specified separately in CakePHP.

	==See Also==		==See Also==

Burger at 22:19, 22 August 2024

2024-08-22T22:19:43Z

← Older revision		Revision as of 18:19, 22 August 2024
Line 1:		Line 1:
	This is community documentation for the API. To see official documentation, review zoneminder.readthedocs.~~org~~.		This is community documentation for the API. To see official documentation, review https://zoneminder.readthedocs.io/en/stable/api.html.
	Users reading this doc may also want to read the wiki page for [[ZMNinja]].		Users reading this doc may also want to read the wiki page for [[ZMNinja]].

Burger: /* Rewrites */

2024-01-16T16:30:40Z

Rewrites

← Older revision		Revision as of 12:30, 16 January 2024
Line 104:		Line 104:
	"^/zm/api(.+)$" => "/zm/api/index.php"		"^/zm/api(.+)$" => "/zm/api/index.php"
	)		)
	The apache one is not intuitive so instead look at lighttpd. ~~That~~ is a (pcre) regex with ^-start with /zm/api then (.+) any number		The apache one is not intuitive so instead look at lighttpd. This is a (pcre) regex with ^-start with /zm/api then (.+) any number
	of characters to the end $ then change to /zm/api/index.php. Essentially, any request that is /zm/api-whatever will be converted to /zm/api/index.php.		of characters to the end $ then change to /zm/api/index.php. Essentially, any request that is /zm/api-whatever will be converted to /zm/api/index.php.