Basic Usage

Welcome to the UBuild API, a remote interaction service within the UBuild tool. This API allows you to interact with the UBuild application via API endpoints. 

 The UBuild API can be configured to work locally (within a LAN) or can be port-forwarded to be accessed from the internet. For security, by default, you must use an API key defined within the api.config. (see more about configuring the API here ) (this can be disabled if only using UBuild within a LAN) 

 Included within each UBuild release is a Postman collection that you can import (documentation/UBuild.postman_collection.json) , this collection will setup setup all UBuild endpoints within a UBuild Collection in Postman. 

 

 The UBuild API will automatically start when the application begins, so-long as the UBuild application is open- you will be able to use the API.