Page History

...

Public APIv2 documentation is located at https://cloud.6connect.com/APIv2/at 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. 

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.

   ExpandImage Modified

...

View APIv2 Information

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

   expand

   Image Removed

2. Once on an API Family page, verify that the displayed server name is correct for your instance/local server. expand
   
   1. 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.
      Image Modified

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
   1. The detail information includes a description, parameter list (required parameters are marked with a *), and response information
      Image Modified

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

   1. Clicking on "Example Value" will show an example of a JSON request body for that call.

   
   

   1. Image Modified

   2. Clicking on "Model" will display details and descriptions of the request body parameters, if available.
      
      Image Modified

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

   Expand At

   1. At the bottom of the page, click on "Models".
      Image Modified

      
      

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

    

   1. Image Modified

Testing/Executing Endpoints in Swagger

...

1.  Navigate to the call that you want to try out.

2.  Expand the call to view its details, then click the "Try it out" button.

   Expand

3. Input the desired parameters to test, and click "Execute".

   Expand
   1. Image Modified
   2. If the call is a method that uses a JSON request body, you will have the option to edit the body text in the "Example Value" box - when done, click "Execute".
      Image Modified

4. The example response will display under "Responses" after being executed. The "Response" section also includes the cURL command, Request URL, and Response Headers.

   expand
   1. Image Modified

APIv2 - Nested Queries

You can use nesting to write more complicated API calls to handle multiple conditions. Here, we'll  illustrate a query with an OR / AND condition, such as to find resource entries with (Section = 76 OR Section = 77) AND managed = Yes:

...

• Developer Tools
• Public APIv2 Swagger documentation :  https://cloud.6connect.com/APIv2/is available on our Swagger page.