Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space DOC and version 7.1.0-7.1.2

Developer Tools

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

API Overview

The 6Connect ProVision API is a RESTful API to access your data in the 6Connect tools. ReST 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 ProVision API operates similarly to other popular ReST 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 REST implementation:

  • The API only comes with the full 6Connect ProVision 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 an SDK for PHP and one for Python. Looking at the sample code would probably help you implement it in any language though.

...

Info
titleAPIv2 Quick Links

Public APIv2 documentation is located at https://cloud.6connect.com/APIv2/located on our Swagger page

APIv2 documentation includes:

  • IPAM APIAPI  
    Includes actions for LIRs, IP aggregate and block management, VLAN, IP Rules, and SWIP.
  • Resource APIAPI  
    Includes actions for managing the ProVision the ProVision Resource System
    The resource API provides CRUD endpoints for resources, resource attributes, resource attachments and resource backups.
  • DNS API
    ProVision DNS API allows you to manage DNS Zones, Records, Servers, Groups and ACLS.
  • Users API
    Includes actions for ProVision Users, permissions and actions.
  • Usergroups API
    Includes actions for ProVision 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 in ProVision to help automate frequently used combinations of calls.


...

Public APIv2 documentation is located at https://cloud.6connect.com/APIv2/. on our Swagger page. 

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

...

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 the Reverse API Gadget.

Toolkit

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

CLI

...