Because Toolbox Enterprise preview.10 is still in development, this documentation may not be entirely accurate and is subject to change.
REST API
Last modified: 16 April 2024
Toolbox Enterprise provides both a user interface (Web UI) and application programming interface (API) to execute all essential operations on the Toolbox Enterprise Server.
Automation Tokens
Most requests to the Toolbox Enterprise Server require the Authorization header. It supports:
OAuth2 tokens from the external OAuth2 service provider used in your company
Automation tokens created on the Toolbox Enterprise Server
Create an automation token
In the Web UI, open the Configuration page and go to the Automation tokens tab.
Click Create Token.
In the New Automation Token dialog, specify the token name in the Client ID field, and set the expiration date for the token.
Swagger Documentation
The Swagger pages are disabled by default on the server. Add the following lines to Toolbox Enterprise's application.yaml to enable Swagger:
springdoc:api-docs:enabled:true
The Swagger API documentation is available at https://<your_organization>/swagger-ui.html.
