Search Results for

    Show / Hide Table of Contents

    Application Programming Interface (API)

    The API may change at any time in the future.

    The documentation for the API is included with each installation instance of the CMon web application.

    For example, https://localhost/ManagementServer/docs.

    Replace "localhost" with the address of the web server.

    The web page that hosts the documentation can also be used to send queries through the API.

    Quick Start

    To authenticate, send a POST request to https://localhost/ManagementServer/api/Account/Authenticate.

    To get a list of cloud storage accounts, send a GET request to https://localhost/ManagementServer/api/CloudStorageAccounts?$top=1.

    Without $top=1, it will return all cloud storage accounts, which may be expensive, so this request should be filtered.

    To filter by a backup client license key, send a GET request to https://localhost/ManagementServer/api/CloudStorageAccounts?$filter=BackupClientLicenseKey eq 'licenseKey'.

    Replace licenseKey with the license key.

    If the response returns an entity, then the license key is being used with a cloud storage account.

    The returned enttiy will also contain properties for the used storage space and storage quota.

    To minimize the amount of data being returned for improved performance, you can select only the properties you want.

    For example, https://localhost/ManagementServer/api/CloudStorageAccounts?$filter=BackupClientLicenseKey eq 'licenseKey'&$select=UsedBytes,ComputedFreeBytes,ComputedQuotaBytes

    More technical documentation for specific query options can be found here:

    http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html

    https://docs.oasis-open.org/odata/odata/v4.01/csprd06/part2-url-conventions/odata-v4.01-csprd06-part2-url-conventions.html

    In This Article
    Back to top © 2022 NovaStor Corporation. All rights reserved. All trademarks are the property of their respective owners. Features and specifications are subject to change without notice. The information provided herein is provided for informational and planning purposes only. Send comments on this topic to support@novabackup.com.
    Download Help Documentation as a PDF.