Versions Compared

Old Version 1

changes.mady.by.user The Force

Saved on

compared with

New Version Current

changes.mady.by.user The Force

Saved on

Key

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

...

The API is a RESTful API to access your data in the ProVision tools. ReST 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 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 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. 

...

Info
titleAPIv2 Sections

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

...

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

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.

    Expand

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.

...