GET
/
waap
/
v1
/
domains
/
{domain_id}
/
api-discovery
/
settings
Python
from gcore import Gcore

client = Gcore(
    api_key="My API Key",
)
waap_api_discovery_settings = client.waap.domains.api_discovery.get_settings(
    1,
)
print(waap_api_discovery_settings.description_file_location)
{
  "descriptionFileLocation": "<string>",
  "descriptionFileScanEnabled": true,
  "descriptionFileScanIntervalHours": 123,
  "trafficScanEnabled": true,
  "trafficScanIntervalHours": 123
}

Authorizations

​
Authorization
string
header
required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234$abcdef

Path Parameters

​
domain_id
integer
required

The domain ID

Required range: x > 0

Response

Successful Response

Response model for the API discovery settings

​
descriptionFileLocation
string | null

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.

​
descriptionFileScanEnabled
boolean | null

Indicates if periodic scan of the description file is enabled

​
descriptionFileScanIntervalHours
integer | null

The interval in hours for scanning the description file

​
trafficScanEnabled
boolean | null

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

​
trafficScanIntervalHours
integer | null

The interval in hours for scanning the traffic