APIv2

Image Added

API v2 Overview

APIv2 is ProVision's currently supported RESTful API version. APIv2 improvements include: 

...

1. Use a browser extension / desktop REST client, such as Postman

   1. Postman is the current industry standard: Go to https://www.getpostman.com/ to install, and visit the Postman Learning Center for user documentation, training videos, and support help.

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.
   1. Continue to the section below: "APIv2 - Using Swagger" for more details, or see the ProVision Developer Tools page for a broader overview.
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 below: "APIv2 - Using cURL" for more details, examples, and tips.

...

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

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.

• Resource View API

Provides CRUD endpoints for resource views.

• DNS API

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

• SSH API

Includes actions for SSH credentials and SHH Routes. 

Existing customers may also access APIv2 documentation 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 the API Tab Tab.

3. Under "OpenAPI 3.0 Specification" click the Swagger link providedthe 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
   Image RemovedImage Added

   
   

Viewing APIv2 Information

1. On the 6connect Provision API Swagger home page, click on the name link for the API family that you wish to browse (IPAM, Resource, DNS, etc).

   Expand
   Image RemovedImage Added

   
   

2. Once on an API Family page, verify that the displayed server name is correct for your instance/local server. 

   Expand
   In most situations, only one ProVision instance/server will be displayed, with authentication already provided from your ProVision login. If your ProVision session has ended, or the server changed, you may need to re-provide ProVision credentials by clicking the "Authorize" button.

   
   

3. Scroll further down the page and begin reviewing available APIv2 calls and details. Clicking on any call will expand it to view parameter details  - you can even test call responses (using your instance data) by clicking "Try it Out"!

   Expand
   The detail information includes a description, parameter list (required parameters are marked with a *), and response information

   
   

4. Some calls that involve a JSON request body payload (PUT, PATCH, etc) will display "Example Value" and "Model" information under a "Request Body" section - additional parameter descriptions may be displayed under "Model" Information. 

   Expand
   Clicking on "Example Value" will show an example of a JSON request body for that call. Clicking on "Model" will display details and descriptions of the request body parameters, if available.

   
   

5. Additional "Model" examples are available at the bottom of the page with additional descriptive information. 

   Expand
   At the bottom of the page, click on "Models". Then, click on the "Model" you wish to view. Some models may contain additional information that you can expand to view, such as valid values for a parameter. In the example below, the circled "array" will display valid RIR values.

   
   

...

See the following areas for additional information:

• ProVision Developer Tools
• Public APIv2 Swagger documentation:  https://cloud.6connect.com/APIv2/.