The BlueCat Overlay workflow includes RESTful API endpoints that can be used to
automate the processes of the workflow. This workflow uses two main HTTP methods for
interacting with different objects:
| HTTP Method | Description |
|---|---|
| GET | Retrieve data |
| POST | Upload data |
Endpoint
When working with the workflow of this API, you can invoke different methods by appending
the API endpoint to the BlueCat Gateway URL. For example, the following
GET API call retrieves DHCP network
information.
GET http://<Gateway_url>/overlay/api/v1/networks
Authorization
The BlueCat Overlay API endpoints require an authorization token to be passed in the header to successfully execute. For more information about obtaining an authorization token, refer to POST /rest_login.