ProVision can integrate with your existing tools and workflow through use of the API and CLI. The API allows you to access the data and functions of the web tools to run advanced commands in ProVision, and supports a wide variety of update and deletion conditions not available in the UI.
To use the API, you will need a basic understanding of object oriented programming in PHP and the right tools installed on your system.
API Overview
The API is a RESTful API to access your data in the ProVision tools. 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 APIs you may have worked with, such as Facebook or Twitter.
Here are some important details about our REST implementation:
-
The API only comes with the full IPAM product.
-
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.
API v2
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.
APIv2 documentation includes the following modules:
-
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 Scheduler 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.
Public APIv2 documentation is located at APIv2 Swagger page.
Existing customers may also access APIv2 Documentation from your instance (user must have Admin permissions).
API v1 (Deprecated)
ProVision's APIv1 system has been replaced by APIv2, and is now considered deprecated.
It is highly recommended that any customer utilizing ProVision's API for custom scripting refer to APIv2 documentation instead, and consider upgrading existing APIv1 scripts to use APIv2.
However, APIv1 documentation will remain accessible in order to support legacy users.
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.
Currently, four Gadgets are available: Global Search, IPAM Search, DHCP Search, and Log. Each Gadget comes in various default option types for display style, number of records return, or behavior. Additional client-side style customizations may be made to further integrate the gadget with company styles.
Reverse API
ProVision's Reverse API calls and UI elements allow for integration with outside APIs to improve workflow and create custom display content. In the ProVision user interface, the Reverse API page allows for endpoints to be built and provides a text editor to create presentation JavaScript commands. This JavaScript presentation code is then displayed in the Reverse API Gadget.
Toolkit
Additional CLI modules are available for power users in the /tools directory.
CLI
Command line interface offering basic IPAM commands, such as Add, Update, Direct Assign, Smart Assign, and Unassign.
Resource Concepts
A developer-oriented overview of the Resource System.