From eb9315c11ca81f2250b3b37316710eed6ef3cc0b Mon Sep 17 00:00:00 2001 From: Matt Layher Date: Thu, 7 Jul 2016 16:15:33 -0400 Subject: [PATCH] Add initial API Integration document --- docs/api-integration.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 docs/api-integration.md diff --git a/docs/api-integration.md b/docs/api-integration.md new file mode 100644 index 000000000..99185adf6 --- /dev/null +++ b/docs/api-integration.md @@ -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.