Overview

The Bigleaf Cloud Connect API is a powerful tool for integrating software directly with the Bigleaf Cloud Connect platform. Designed to ensure uninterrupted performance for critical cloud and internet applications, Bigleaf automatically detects and mitigates circuit and traffic issues, proactively resolving problems before they affect users. With comprehensive network performance insights, actionable alerts, and detailed reporting, our service empowers customers to optimize connectivity and take control of their network data.

Features and Applications

The Bigleaf Cloud Connect API provides flexible capabilities to enhance and customize network management, including:

• Accessing real-time site, alert, circuit and device statuses for proactive monitoring.

• Viewing account, company and site settings you have access to.

• Automating workflows based on actionable data provided by the Bigleaf Cloud Connect platform.

By leveraging Bigleaf’s network insights, you can create efficient workflows without relying solely on the Bigleaf Web Dashboard.

API Documentation

For more information on the Bigleaf Cloud Connect API, including its available routes, please visit our Swagger API specification.

API Token Management

The Bigleaf Cloud Connect API uses HTTP token-based authentication. API Token access is available in the Bigleaf Cloud Connect Dashboard User settings page under the Token management section. By default, token management is disabled for an account. To enable access, you must contact your company’s Super Admin or Bigleaf Support.

Create an API Token

To create an API token, navigate to User settings page, locate the Token management section, and click the “New token” button. The generated API token will be linked to the Bigleaf Cloud Connect user account that created it, inheriting the same permissions. You can create or delete tokens on this page at any time.

Using the API token

Below is an example of the API token credentials:

 

The basic authentication credentials are <token_key>:<token_auth>. An example of usage with curl:

curl -u 'vFJA3Q2k6y_9Uk4RogoHCDpG:6XnC6i3jW-9boKNXirULTudf' \
    https://api.bigleaf.net/v2

Be sure to base-64 encode your credentials if sending them via an Authorization HTTP header

GET /v2 HTTP/1.1
Authorization: Basic dkZKQTNRMms2eV85VWs0Um9nb0hDRHBHOjZYbkM2aTNqVy05Ym9LTlhpclVMVHVkZg==

API Token Lifecycle and Best Practices

API tokens play a vital role in authenticating and integrating with the Bigleaf Cloud Connect API. Understanding their lifecycle and implementing best practices for management is essential to maintain security and functionality.

• Generation and Storage: API token passwords are not stored by Bigleaf in plaintext. Upon generation, it is the user's responsibility to securely record the credentials. Passwords cannot be retrieved later, so ensure they are stored securely.

• Permissions: API tokens inherit the permissions of the user's Bigleaf Cloud Connect Dashboard account. This includes access to all companies and sites the user's account can access.

• Access Changes: If a user is removed from a company, their API token will automatically lose access to the company and its associated sites.

• Privilege Revocation: Disabling the user's API Token Management privileges will revoke all active API tokens tied to their account immediately.

• Expiration: API tokens do not expire. However, it is highly recommended to periodically rotate tokens by revoking existing ones and generating new tokens to enhance security.