General Structure of the API¶
The VOSS Automate API accesses system resources or tools.
Resources
The general structure of an API URL for accessing a system resource (an endpoint) is:
Method https://servername/api/Resource/Action/?Parameters
Where:
Method
[GET|POST|DELETE|PUT|PATCH]
Servername
The installation server determines the base URL, e.g. https://servername.
In a cluster environment, this is the address of the web proxy node.
Refer to the Install Guide for cluster deployment information.
api
A static string in the URL that is a part of the endpoint.
Resource
(str:modeltype/str:modelname)[/pkid]
Refer to the relevant API Reference guides for a list of supported resources.
Action
For a complete list of actions supported for resources in the system and for a list of custom actions, refer to the relevant API Reference Guides.
Parameters
[(str:api parameter)[&(str:api parameter)...]]
The HTTP methods and parameters are described in relevant sections. The different resources supported in the system are described in the API Reference Guides.
Tools
The general structure of the URL structure for Tools is, for example:
[GET|POST] /api/tool/(str:tool_name)/