API Reference Overview#
Farm exposes API endpoints for its various services. These endpoints are intended for developers wanting to integrate Farm more deeply into their workflows and toolsets.
View API Reference Documentation
Accessing the Live API documentation#
While we provide reference documentation for the APIs in this section, you can also use the live documentation feature of your Farm instance. This allows you to review the API and submit live queries against the services. They are enabled by default and can be found at the following URL:
https://<ip_address:8222>/docs
Securing Your Farm Instance#
If deploying your Farm instance into an unsecured environment, such as a cloud provider, we strongly recommend using security groups and API Gateways as these offer numerous benefits. The most important of which is the ability to secure the API end-points by integrating with your chosen IAM solution.
Warning
The Farm services do not implement their own authentication and authorization mechanisms. Instead, customers are expected to bring their own implementations to manage access to the API endpoints.