admin_status

Model for admin status endpoints, including Zotonic version and health/status overview values.

Available Model API Paths

MethodPath patternDescription
get/zotonic_version/...Return the running Zotonic version string for admin users (ACL-protected).
get/database_version/...Return the database server version string (admin ACL-gated via m_get/3).
get/otp_version/...Return the exact Erlang/OTP version string (admin ACL-gated via m_get/3).
get/config_dir/...Return the active configuration directory path.
get/security_dir/...Return the configured security directory path (z_config:get(security_dir)).
get/log_dir/...Return the configured log directory path (z_config:get(log_dir)).
get/data_dir/...Return the configured data directory path (z_config:get(data_dir)).
get/cache_dir/...Return the configured cache directory path (z_config:get(cache_dir)).
get/work_dir/...Return the current working directory of the running node.
get/files_dir/...Return the site files base directory derived from z_path:files_subdir/2.
get/tcp_connection_count/...Return the current number of open TCP sockets (recon:tcp/0).
get/group_sockets/...Return open TCP sockets grouped by peer IP with counts and ports.
get/memory/used/...Return memory usage grouped by allocator (recon_alloc:memory(used)).
get/memory/allocated/...Return allocated memory grouped by allocator (recon_alloc:memory(allocated)).
get/memory/unused/...Return unused memory grouped by allocator (recon_alloc:memory(unused)).
get/memory/usage/...Return allocator memory usage ratios (recon_alloc:memory(usage)).
get/disks/...Return disk space information for mounted disks.
get/disks/alert/...Return whether any disk usage crosses configured alert thresholds.
get/os_memory/...Return operating-system memory statistics.
get/os_memory/alert/...Return whether OS memory pressure crosses alert thresholds.
get/task_queue/...Return pivot/task queue counters from z_pivot_rsc:count_tasks/1.
get/is_ssl_application_configured/...Return whether the ssl application has session settings configured.
get/init_arguments/...Return all Erlang VM init arguments (init:get_arguments/0).
get/init_arguments/config/...Return only -config init argument values.

/+name marks a variable path segment. A trailing /... means extra path segments are accepted for further lookups.

Edit on GitHub