Developer Tools

6connect ProVision can integrate with your existing tools and workflow through use of the API and CLI. The 6connect API allows you to access the data and functions of the 6connect 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

API Overview

The 6Connect API is a RESTful API to access your data in the 6Connect tools. ReST relies on stateless, client-server communication, and is implemented using the HTTP protocol (the 6Connect APIv2 uses HTTPS). 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 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. We currently have an SDK for PHP and one for Python. Looking at the sample code would probably help you implement it in any language though.

API v2

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 ProVision instance ( instance/dev/swagger), which provides the ability to test inputs and responses using your ProVision instance data. 

APIv2 Swagger Documentation

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

Existing customers may also 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" click the Swagger link provided.

   Click here to expand...

   

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

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 System.

Table of Contents

• APIv2
• API v1 (Deprecated)
• Portable Gadgets
• Reverse API
• Toolkit
• CLI (Alpha)
• Resource Concepts

Developer Tools

6connect ProVision can integrate with your existing tools and workflow through use of the API and CLI. The 6connect API allows you to access the data and functions of the 6connect 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

API Overview

The 6Connect API is a RESTful API to access your data in the 6Connect tools. ReST relies on stateless, client-server communication, and is implemented using the HTTP protocol (the 6Connect APIv2 uses HTTPS). 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 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. We currently have an SDK for PHP and one for Python. Looking at the sample code would probably help you implement it in any language though.

API v2

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 ProVision instance ( instance/dev/swagger), which provides the ability to test inputs and responses using your ProVision instance data. 

APIv2 Swagger Documentation

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

Existing customers may also 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" click the Swagger link provided.

   Click here to expand...

   

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

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 System.

Table of Contents

• APIv2
• API v1 (Deprecated)
• Portable Gadgets
• Reverse API
• Toolkit
• CLI (Alpha)
• Resource Concepts