Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update api-discovery.md #1440

Merged
merged 1 commit into from
Nov 13, 2024
Merged

Update api-discovery.md #1440

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 11 additions & 5 deletions documentation/waap/api-discovery-and-protection/api-discovery.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,19 +154,25 @@ The scan history also displays information about the scan time, analyzed source,

## Settings

On this page, you can choose the preferred ways of detecting potential API endpoints, configure network scan intervals, and manually add APIs to the base path.
On this page, you can choose the preferred ways of detecting potential API endpoints, configure network scan intervals, and <a href="https://gcore.com/docs/waap/api-discovery-and-protection/configure-api-base-path" target="_blank">manually add APIs to the base path</a>.

<img src="https://assets.gcore.pro/docs/waap/api-discovery-and-protection/settings.png" alt="Settings page in the Customer Portal" width="80%">

<alert-element type="warning" title="Warning">

Manually adding endpoints to the base path is only necessary if you don't have the API discovery feature enabled. If you're using API discovery, manage all your APIs on the **API Baseline** page.

</alert-element>

### Configure base path

For guidelines on how to configure API base path in Gcore WAAP, check out the <a href="https://gcore.com/docs/waap/api-discovery-and-protection/configure-api-base-path" target="_blank">Manually add endpoints to API base path</a> guide.
For guidelines on how to configure the API base path in Gcore WAAP, check out the <a href="https://gcore.com/docs/waap/api-discovery-and-protection/configure-api-base-path" target="_blank">Manually add endpoints to API base path</a> guide.

### Specify API specification files

One of the ways to add APIs to API Discovery feature is to parse an uploaded JSON or YAML Swagger file. Detected API endpoints will appear on thewa page with the **Confirmed** status.
One of the ways to add APIs to the API Discovery feature is to parse an uploaded JSON or YAML Swagger file. Detected API endpoints will appear on the page with the **Confirmed** status.

Uploading a Swagger file can significantly reduce the work needed for categorizing of potential APIs, as this will automatically classify most of the endpoints that comprise the API Baseline.
Uploading a Swagger file can significantly reduce the work needed for categorizing potential APIs, as this will automatically classify most of the endpoints that comprise the API Baseline.

This is how you can do it:

Expand All @@ -188,4 +194,4 @@ In this section, you can choose how the system will detect your APIs:

* **API specification scans**. When this toggle is enabled, API Discovery will scan your uploaded API Specification file or specified API paths to see if any new endpoints were added or if any existing endpoints were removed (delisted).

You can customize scan intervals by selecting the relevant option from the **Scan every** dropdown.
You can customize scan intervals by selecting the relevant option from the **Scan every** dropdown.