v32

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-151,1412,2144.5 MB
API Discovery

Update the API discovery settings

Update the API discovery settings for a domain

patch/waap/v1/domains/{domain_id}/api-discovery/settings

Path parameters

domain_idinteger required

The domain ID

The domain ID

Request body

descriptionFileLocationstring nullable

The URL of the API description file. This will be periodically scanned if descriptionFileScanEnabled is enabled. Supported formats are YAML and JSON, and it must adhere to OpenAPI versions 2, 3, or 3.1.

descriptionFileScanEnabledboolean nullable

Indicates if periodic scan of the description file is enabled

descriptionFileScanIntervalHoursinteger nullable

The interval in hours for scanning the description file

trafficScanEnabledboolean nullable

Indicates if traffic scan is enabled

trafficScanIntervalHoursinteger nullable

The interval in hours for scanning the traffic

Response

Successful Response

descriptionFileLocationstring nullable

The URL of the API description file. This will be periodically scanned if descriptionFileScanEnabled is enabled. Supported formats are YAML and JSON, and it must adhere to OpenAPI versions 2, 3, or 3.1.

descriptionFileScanEnabledboolean nullable

Indicates if periodic scan of the description file is enabled

descriptionFileScanIntervalHoursinteger nullable

The interval in hours for scanning the description file

trafficScanEnabledboolean nullable

Indicates if traffic scan is enabled. Traffic scan is used to discover undocumented APIs

trafficScanIntervalHoursinteger nullable

The interval in hours for scanning the traffic