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.2.0-7.2.1

...

The ProVision API is a RESTful API to access your data in the tools. REST relies on stateless, client-server communication, and is implemented using the HTTP protocol (APIv2 uses HTTPS). It is a simple and lightweight alternative to Web Services and can implemented in nearly any language. The ProVision API operates similarly to other popular ReST REST APIs you may have worked with, such as Facebook or Twitter. 

...

Here are some important details about our ReST REST implementation:

  • The API only comes with the full ProVision IPAM product. 
  • 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.

...

Info
titleAPIv2 Quick Links

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

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 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):

...