The API Docs Dashboard displays all modules connected to an API or remote execute in the environment. The tool auto-generates documentation for each module, including descriptions, request and response parameters, and data types.
Remote executes interface with a module through an API call instead of loading it in the browser. An API module can refer to a remote execute module or a module with a basic API call.
Access Requirements
Access to the API Docs Dashboard depends on role configuration.
Environment Roles (without WSRBAC): Creator roles can view all data in this tool.
WSRBAC: Creators can view data for modules and workflows inside workspaces where they have access. If data is missing, the Creator might not have access to the workspace containing that module.
Dashboard Filters
The dashboard displays all API modules in the environment. Results update automatically as text is entered. Click the funnel icon on the right to clear all filters.
| Filter | Description |
|---|---|
| Namespace | Filters by the namespace tag applied to a module. To register a module as an API module, add api to its Module Tags. To define a namespace, add api-namespace:yourNamespace (for example, api-namespace:dogs). The Namespace field uses autocomplete based on namespaces already used in the environment. |
| Title | Filters by the module title. |
| ID | Filters by the module's unique identifier. |
| Path | Filters by the module path. |
The table displays 10 entries by default. Use the numbered buttons below the table to navigate to additional entries.
API Module Details
Click View on the right side of a table entry to open the module's API documentation.
The detail view displays the following:
- Module title and description
- HTTP method: GET, PUT, POST, or DELETE
- Links to Server-Side Module Execution documentation
- Request table
- Response table
Request Table
| Column | Description |
|---|---|
| Parameter | The Property ID of the component in the API module. |
| Type | The expected data type. Add type: tags to the module's Module Tags to specify types. Options include: type:string, type:number, type:boolean, type:array, type:object, or type:objectId. |
| Required | Whether the parameter is required. |
| Comments | A brief description of the request parameter. |
Response Table
| Column | Description |
|---|---|
| Parameter | The Property ID of the component in the API module. |
| Type | The expected response data type, specified with type: tags on the module. Options include: type:string, type:number, type:boolean, type:array, type:object, or type:objectId. |
| Comments | A brief description of the response parameter. |
Best Practices
- Add the
apitag to API modules so they appear in the dashboard. - Use the API Specification snippet when building API modules to ensure documentation renders correctly in the dashboard.
- Set Server Side Execution Only to ON on API modules.
Changelog
| Date | Change |
|---|---|
| 2026-07-16 | Editorial pass: fixed banned words, em dashes, See Also descriptions, and link paths. |
| 2026-04-28 | Updated to Reference Guide format. Fixed metadata and headings. Restructured sections. Improved table column naming. Updated alt text. |