Agent Configuration using Swagger

GuardMode provides an interactive Swagger (OpenAPI) interface that allows administrators to view available endpoints, inspect request and response formats, and execute API calls directly from a browser. This simplifies the process of testing configuration and integrating GuardMode into automated workflows.

Accessing the Swagger UI

The Swagger interface is served by the GuardMode Agent on the port 5000 , the same as the API.

Important.

Each connection to Swagger requires authorization. This process requires credentials set up during installation:

• Setting up Basic Authentication on Windows
• Setting up Basic Authentication on Linux.

Alternatively, to update your basic authentication credentials, run

./Catalogic.GuardMode.Agent config update basic-authentication --username {username} --password {password}

Authorizing as a Swagger User

1. Open a web browser and navigate to:

http://<GuarMode Agent IP>:5000/swagger

2. Select API v1 from the dropdown in the topbar. API v2 is for backward compatibility only.
3. Click the Authorize button and provide the same credentials as in Step 1.

4. Click Authorize, then close the dialog window.
   The padlock icons will change to the closed state.

Using Swagger

Swagger allows you to browse available endpoints, grouped by functionality. You can view requests and response schemas, execute requests and obtain responses directly from the web browser, and generate code snippets for different languages and tools.