Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from this space and version 8.3.0
HTML
<div id="google_translate_element"></div>
<script type="text/javascript">
function googleTranslateElementInit() {
  new google.translate.TranslateElement({pageLanguage: 'en'}, 'google_translate_element');
}
</script>
<script type="text/javascript" src="//translate.google.com/translate_a/element.js?cb=googleTranslateElementInit"></script>

Developer Tools

6connect ProVision can integrate with your existing tools and workflow through use of the API and CLI.  The 6connect The API allows you to access the data and functions of the 6connect web tools to to run advanced commands in ProVision, and supports a wide variety of update and deletion conditions not available in the UI.

...

Table of Contents
maxLevel2

Theming Customization

In addition to the standard Light / Dark Mode themes available in ProVision, several methods are available to customize the entire product, allowing for additional company branding and fine control over what areas of the product are visible and what are not.

Theming Customization includes:

  • Changing the instance logo and brand name
  • Customizing the visible tabs or subtabs instance-wide
  • Creation of fully custom themes to match company branding
Info

Note: Theming customization requires read/write access on the instance's "assets" directory, and experience using vi or another text editor of your choice to edit options.

Creating a custom theme requires strong CSS knowledge, as well as access and write permissions to your instance's "assets" directory

API Overview

The 6Connect API is a RESTful API to access your data in the 6Connect ProVision tools. ReST relies on stateless, client-server communication, and APIv2 is implemented using the HTTP protocol (the 6Connect APIv2 uses HTTPS)HTTPS protocol. It is a simple and lightweight alternative to Web Services and can implemented in nearly any language. The 6Connect API operates similarly to other popular ReST APIs you may have worked with, such as Facebook or Twitter. To learn more about request formatting, making requests, and the tools available, visit Making API Requests. You can also get the PHP SDK for PHP libraries and sample code.

Here are some important details about our ReST implementation:

  • The API only comes with the full 6Connect IPAM full IPAM product. If you would like to upgrade to the full version, contact sales@6Connect.com.
  • All transactions are over HTTPS (SSL - port 443) only. Any transaction not using SSL will be rejected, and you will have potentially exposed sensitive data.
  • All API results are formatted in JSON. XML support is coming soon.
  • APIv2 requests use standard HTTP methods such as GET, PUT, POST, PATCH, and DELETE.  We suggest using POST if the length of data in the request is over 8KB.
  • You can use any language you would like to query the API. 

API

...

v2

Info
titleAPIv2 Sections

Public APIv2 documentation is located at https://cloud.6connect.com/APIv2/

Existing customers may access APIv2 Documentation from your instance (user must have Admin permissions):

APIv2 documentation includes:

  • IPAM API

Includes actions for LIRs, IP aggregate and block management, VLAN, IP Rules, and SWIP.

  • Resource API

Includes actions for managing the Resource System. 
The resource API provides CRUD endpoints for resources, resource attributes, resource attachments and resource backups.

  • Resource View API

Provides CRUD endpoints for resource views.

  • DNS API

The DNS API allows you to manage DNS Zones, Records, Servers, Groups and ACLS.

  • Peering API

Allows you to manage routers and BGP sessions.

  • Contacts API

Allows you to manage contacts.

  • Users API

Includes actions for users, permissions and actions.

  • Usergroups API

Includes actions for groups, permissions and actions

  • Scheduler API

The API Allows you to easily schedule tasks.

  • API Composer Platform

API Composer Platform (ACP) is an additional module to help automate frequently used combinations of calls.

  • SSH API

Includes actions for SSH credentials and SHH Routes. 

...


APIv2 is ProVision's currently supported RESTful API version. APIv2 adds new endpoints and upgraded functionality over APIv1, through use of HTTPS authentication, additional HTTP methods (GET, PUT, POST, etc.), and JSON payloads.

...

  1. Use a browser extension REST client, such as Postman
  2. Access ProVision's APIv2 Swagger documentation from your ProVision instance your instance ( instance/dev/swagger), which provides the ability to test inputs and responses using your ProVision instance data. 

APIv2 Swagger Documentation

  1. your instance data.
    1. Continue to the section: "APIv2 - Using Swagger" at APIv2 for more details.
  2. Use CURL in the command line to authenticate and execute APIv2 endpoints. See cURL documentation at https://curl.haxx.se/.
    1. Continue to the section: "APIv2 - Using cURL" at APIv2 for more details.

APIv2 Swagger Documentation

Public APIv2 documentation is located at https://cloud.6connect.com/APIv2/

Existing customers may also access APIv2 Documentation from your instance Access APIv2 Documentation from your ProVision instance (user must have Admin permissions):

  1. Log into your ProVision instance.
  2. Go to the Admin area of ProVision and click on the API Tab.
  3. Under "OpenAPI 3.0 Specification" the API dropdown menu, click the Swagger link provided.

    Expand
    Image Removed

API v1 (Deprecated)

ProVision's APIv1 system has been replaced by APIv2, and is now considered deprecated. 

It is highly recommended that any customer utilizing ProVision's API for custom scripting refer to APIv2 documentation instead, and consider upgrading existing APIv1 scripts to use APIv2.

However, APIv1 documentation will remain accessible from the links below in order to support legacy uses.

Portable Gadgets

ProVision's Portable Gadgets are drop-in code snippets that use the ProVision API to bring in data to other systems or web pages. Portable Gadgets allow for quick data access and increased integration.

Currently, four Gadgets are available: Global Search, IPAM Search, DHCP Search, and Log. Each Gadget comes in various default option types for display style, number of records return, or behavior. Additional client-side style customizations may be made to further integrate the gadget with company styles.

Reverse API

ProVision's Reverse API calls and UI elements allow for integration with outside APIs to improve workflow and create custom display content. In the ProVision user interface, the Reverse API page allows for endpoints to be built and provides a text editor to create presentation JavaScript commands. This JavaScript presentation code is then displayed in the Reverse API Gadget.

Toolkit

  1. You may also click on the "APIv2 Swagger Documentation" link provided under the APIv2 section of the page.

    Expand
    Image Added


Toolkit

Additional CLI modules are available for 6connect provides customers with additional CLI modules for ProVision power users in the /tools directory.

CLI

Command line interface offering basic IPAM commands, such as Add, Update, Direct Assign, Smart Assign, and Unassign.

Resource Concepts

A developer-oriented overview of ProVision's Resource the Resource System.


Table of Contents

Children Display
excerpttrue
excerptTypesimple