Page History

...

APIv2 documentation includes:

• IPAM APIAPI  
  Includes actions for LIRs, IP aggregate and block management, VLAN, IP Rules, and SWIP.
• Resource APIAPI  
  Includes actions for managing the ProVision 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.

...

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

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.

...