Actions

API: actions

Key Type Embeddable Allowed
_id String - Any
jid String - Any
action String - Any
host String hosts._id Any
state String - ‘queued’, ‘in progress’, ‘finished’, ‘expired’
_updated Datetime - Any
_created Datetime - Any

Alerts

API: alerts

Key Type Embeddable Allowed
_id String - Any
type String - Any
level String - ‘debug’, ‘info’, ‘warning’, ‘error’
read Boolean - Any
payload JSON object - Any
_updated Datetime - Any
_created Datetime - Any

Failed patches

API: failed patches

Key Type Embeddable Allowed
_id String - Any
jid String - Any
action String - Any
args String - Any
patch String - Any
host String hosts._id Any
state String - ‘queued’, ‘in progress’, ‘finished’, ‘expired’
return Array - Any
_updated Datetime - Any
_created Datetime - Any

Files

API: files

Key Type Embeddable Allowed
_id String - Any
name String - Any
data Media - Any
_updated Datetime - Any
_created Datetime - Any

Groups

API: groups

Key Type Embeddable Allowed
_id ObjectId - Any
name String - Any
type Integer - 0-6
subgroups Array groups._id Any
info JSON object - Any
_updated Datetime - Any
_created Datetime - Any

Types of groups:

Number Type
0 Flexible
1 Functional (salt nodegroups)
2 Gateway
3 Subnetwork
4 Organization
5 Master
6 Vpn Organization

Hosts

API: hosts

Key Type Embeddable Allowed
_id String - Any
_soft_deleted Boolean - Any
identification_number String - Any
status String - ‘up’, ‘down’, ‘no response’
version String - Any
heartbeat Datetime - Any
last_action String actions._id Any
last_stateapply Datetime - Any
last_distupgrade Datetime - Any
ip String - Any
mac_addresses Array - Any
ip_addresses Array - Any
nat Boolean - Any
groups Array groups._id Any
nodegroups Array nodegroups.name Any
grain JSON object - Any
key String - ‘accepted’, ‘rejected’, ‘denied’, ‘unaccepted’
vpn_organization String vpn_organizations._id Any
pritunl_represenation JSON object - Any
fingerprint String - Any
fingerprint_history Array - Any
_updated Datetime - Any
_created Datetime - Any

Hosts statistic

API: hosts statistic

Key Type Embeddable Allowed
_id ObjectId - Any
index Integer - Any
timestamp Datetime - Any
hosts Array - Any
_updated Datetime - Any
_created Datetime - Any

Nodegroups

API: nodegroups

Key Type Embeddable Allowed
_id ObjectId - Any
name String - Any
type Integer - 1
subgroups Array groups._id Any
info JSON object - Any
_updated Datetime - Any
_created Datetime - Any

Settings

API: settings

Key Type Embeddable Allowed
_id ObjectId - Any
addresses JSON object - Any
_updated Datetime - Any
_created Datetime - Any

Addresses schema:

Key Type Embeddable Allowed
file String files._id Any
resolver_address String - Any
master_address String - Any

Tasks

API: tasks

Key Type Embeddable Allowed
_id ObjectId - Any
salt_client String - ‘local_async’, ‘runner_async’, ‘wheel’
name String - Any
status String - ‘scheduled’, ‘paused’, ‘finished’, ‘overdue’
fun String - Any
tgt Array - Any
arg Array - Any
kwarg JSON object - Any
start Datetime - Any
end Datetime - Any
next Datetime - Any
interval Integer - Any
count_of_execution Integer - Any
_updated Datetime - Any
_created Datetime - Any

Updates

API: updates

Key Type Embeddable Allowed
_id ObjectId - Any
name String - Any
text String - Any
description String - Any
_updated Datetime - Any
_created Datetime - Any

Vpn Managers

API: updates

Key Type Embeddable Allowed
_id ObjectId - Any
name String - Any
server_address String - Any
dashboard_address String - Any
username String - Any
password String - Any
_updated Datetime - Any
_created Datetime - Any

Vpn Organizations

API: updates

Key Type Embeddable Allowed
_id ObjectId - Any
name String - Any
type Integer - 6
subgroups Array groups._id Any
info JSON object - Any
vpn_manager String vpn_managers._id Any
pritunl_representation JSON object - Any
_updated Datetime - Any
_created Datetime - Any