Chapter 2. Browsing with the API
REST APIs give access to resources (data entities) through URI paths.
Procedure
Go to the automation controller REST API in a web browser at:
https://<gateway server name>/api/controller/v2
- Click the "v2" link next to "current versions" or "available versions". Automation controller supports version 2 of the API.
-
Perform a
GET
with just the/api/
endpoint to get thecurrent_version
, which is the recommended version. -
Click the
icon on the navigation menu, for documentation on the access methods for that particular API endpoint and what data is returned when using those methods.
-
Use the
PUT
andPOST
verbs on the specific API pages by formatting JSON in the various text fields.
You can also view changed settings from factory defaults at /api/v2/settings/changed/
endpoint. It reflects changes you made in the API browser, not changed settings that come from static settings files.