This reference documents every public function of the SC//AcuVigil™ API. Public functions are available to anyone with a valid SC//AcuVigil user account and the permissions the function requires. For authentication, session handling, error handling, and worked examples, start with Getting started with the SC//AcuVigil API; this reference covers the individual functions that guide points to.
Important: The SC//AcuVigil API is documented as it currently exists and is provided as is. Scale Computing doesn't guarantee its availability, behavior, or compatibility, and may change it without notice. |
Every public function is an HTTPS endpoint of the form https://apiv2.acumera.net/public/<functionName>. Parameters are sent as a form-encoded POST body and responses are JSON. Every response carries a success field, which is "1" on success and "0" on failure, so check it before using the payload: a failed call still returns HTTP 200.
Authentication
Logging in, ending a session, and managing account passwords.
| Function | Description |
|---|---|
| login | Sets an authentication cookie upon receipt of valid auth credentials. |
| logout | Removes the authentication cookie from the client device. |
| changePassword | Allows a user to update their password. |
| resetPassword | Sends a password reset email to the user. |
Companies
Company records and the support contacts associated with them.
| Function | Description |
|---|---|
| getCompanyInfo | Returns information about the specified company and, optionally, all the company's locations. |
| getSupportInfo | Returns a set of support resource links and phone numbers. |
Locations
Finding locations geographically.
| Function | Description |
|---|---|
| getNearbyLocations | Returns a list of nearby locations based on the submitted latitude, longitude, max_distance and min_locations parameters. |
Location notes
Notes attached to a location or company, including file attachments.
| Function | Description |
|---|---|
| getLocationNotes | Returns the contents of all location notes for a company or location. |
| getLocationNote | Returns the contents of a specified location note. |
| addLocationNote | Add a location note to a specific location or company. |
| updateLocationNote | Update a specified location note. |
| deleteLocationNote | Delete a specified location note. |
| getLocationNoteAttachment | Returns the attachment of a specified location note, if one exists. |
Location photos
Photographs attached to a location.
| Function | Description |
|---|---|
| getLocationPhotos | Returns a list of all photo details for a specified location, including thumbnail file contents if specified. |
| getLocationPhoto | Returns details of a specified location photo, including the file contents. |
| addLocationPhoto | Upload a location photo. |
| updateLocationPhoto | Allows for editing of a location photo description. |
| deleteLocationPhoto | Delete a specified location photo. |
Devices
Device status, registration, registration templates, and firewall policies.
| Function | Description |
|---|---|
| getStatusDocument | Returns the current status document(s) for all devices at a location. |
| getRegisteredDevices | Returns a list of registered devices at a location, along with their current status. |
| getUnregisteredDevices | Returns a list of unregistered devices at a location. |
| registerDevices | Allows for registration of devices, using a specified device template. |
| getDeviceTemplates | Returns the list of available device templates at a location. |
| getDeviceTemplateMatches | Returns the list of devices available for registration at a location, given a specified template. |
| getPolicies | Returns a list of firewall policies for a specified company or location. |
Installation and activation
Activating an edge security device (ESD) and tracking its installation progress.
| Function | Description |
|---|---|
| activateMG | Activate an edge security device (ESD) at a location. |
| getMGActivationStatus | Returns whether or not an ESD has successfully been activated and is pushing status. |
| getMGInstallStatus | Returns whether or not the specified ESD is available for install at the specified location; if so, also returns the list of available LAN numbering templates. |
Platform services
Supporting services the dashboard and mobile clients consume.
| Function | Description |
|---|---|
| getAppServices | Returns a list of available mobile app services, based on the user's role and permissions. |
| getAppUpdateDetails | Returns mobile app versioning and update information. |
| getChatCredentials | Returns the credentials required to initiate a chat session. |
| getGoogleAPIKeys | Returns Google API credentials for use with Google Maps, etc. |