|
|
@@ -0,0 +1,19 @@
|
|
|
+# API Integration
|
|
|
+
|
|
|
+NetBox features a read-only REST API which can be used to integrate it with
|
|
|
+other applications.
|
|
|
+
|
|
|
+In the future, both read and write actions will be available via the API.
|
|
|
+
|
|
|
+## Clients
|
|
|
+
|
|
|
+The easiest way to start integrating your applications with NetBox is to make
|
|
|
+use of an API client. If you build or discover an API client that is not part
|
|
|
+of this list, please send a pull request!
|
|
|
+
|
|
|
+- **Go**: [github.com/digitalocean/go-netbox](https://github.com/digitalocean/go-netbox)
|
|
|
+
|
|
|
+## Documentation
|
|
|
+
|
|
|
+If you wish to build a new API client or simply explore the NetBox API,
|
|
|
+Swagger documentation can be found at the URL `/api/docs/` on a NetBox server.
|
Jeremy Stretch