APIv2

Image Added

API v2 Overview

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.

To test APIv2 queries, you may:

1. Use a browser extension REST client, such as Postman
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. 

APIv2 Swagger Documentation

Accessing Swagger

Access APIv2 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 API Tab.

3. Under "OpenAPI 3.0 Specification" click the Swagger link provided.

   Expand
   Image 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 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. Image Added

   
   

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 Image Added

   
   

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. Image Added Clicking on "Model" will display details and descriptions of the request body parameters, if available. Image Added

   
   

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". Image AddedThen, 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. Image Added

   
   

Testing Endpoints

You may test queries in Swagger by using the "Try it out" button for any call. 

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
   Image Added

   
   

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

   Expand
   Image Added 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 Added

   
   

4. The example response will display under "Responses" after being executed.

   Expand
   Image Added