You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 26 Next »

Developer Tools

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

To use the API, you will need a basic understanding of object oriented programming in PHP and the right tools installed on your system. 

Table of Contents

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

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 API is a RESTful API to access your data in the ProVision tools. ReST relies on stateless, client-server communication, and APIv2 is implemented using the HTTPS protocol. It is a simple and lightweight alternative to Web Services and can implemented in nearly any language. The 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 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

APIv2 Sections

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

APIv2 documentation includes:

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

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

Provides CRUD endpoints for resource views.

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

Allows you to manage routers and BGP sessions.

Allows you to manage contacts.

Includes actions for users, permissions and actions.

Includes actions for groups, permissions and actions

The API Allows you to easily schedule tasks.

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

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.

To test APIv2 queries, you may:

  1. Use a browser extension REST client, such as Postman
  2. Access ProVision's APIv2 Swagger documentation from your instance ( instance/dev/swagger), which provides the ability to test inputs and responses using your instance data.
    1. Continue to the section: "APIv2 - Using Swagger" at APIv2 for more details.
  3. 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 (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 the API dropdown menu, click the Swagger link provided. You may also click on the "APIv2 Swagger Documentation" link provided under the APIv2 section of the page.

Portable Gadgets

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.

Toolkit

Additional CLI modules are available for 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 the Resource System.


Table of Contents

  • No labels