Skip to content

Latest commit

 

History

History
58 lines (34 loc) · 4.36 KB

File metadata and controls

58 lines (34 loc) · 4.36 KB
description Explore the details of API collection and more.

API Collection

Akto automatically groups similar APIs into meaningful collections based on their subdomain names. However, you can sort and also create your own custom API collection if you want.

For example, if you want all your payment APIs to be part of a separate collection, you can create a new collection named "Payment APIs" and then add all APIs that start with "/payments" to this newly created collection.

You can also set environment type for an API collection as Staging or Production.

View API Collection

In the demonstration below, let's check out and view details for the API collection viz.- New Burp.

Go to the API Discovery > API Collection and click on any API Collection to view its Endpoints (New Burp in this case).

{% embed url="https://demo.arcade.software/O0Ye3U1iQE7ZAagqYpAw?embed=" %} View an API collection {% endembed %}

In the above demonstration, you can see all 32 endpoints in the collection. Click on any endpoint to view more details about it.

Sort API Collection

In the demonstration below, we have sorted the API collections using two parameters viz.- "More” and “Endpoints". Using these two parameters together makes it easy to access API collections having more endpoints

Go to API Discovery > API Collection. Click on the Sort icon to sort the API Collections.

{% embed url="https://demo.arcade.software/7kVYpBGCOmijEIZoQ0Qu?embed=" %} Sort an API collection {% endembed %}

In the above demonstration, we have sorted the API collection according to the "More” and “Endpoints" parameters. All the API collections are now ordered by the number of endpoints they contain.

Search or Filter Collection

The following table describes all available search and filter options for API inventory records.

Filter NameAvailable ValuesDescription
Risk Score0, 1, 2Filters APIs based on calculated security risk. A higher value indicates higher risk.
Access TypePublic, PrivateFilters APIs based on network exposure. Public APIs are internet-accessible, while private APIs are internally restricted.
Authentication TypeBasic, BearerFilters APIs by the authentication mechanism used by the endpoint, including custom authentication types visible in the API Collection list.
HTTP MethodGET, POST, PUT, DELETEFilters APIs by supported HTTP operations, helping distinguish read and write behaviors.
Response Code200, 201, 204Filters APIs based on observed successful HTTP response codes.
Last TestedTimestamp rangeFilters APIs based on the most recent security test execution time.
Last SeenTimestamp rangeFilters APIs based on the most recent traffic observation time.
Discovered TimestampTimestamp rangeFilters APIs based on when Akto first discovered the endpoint.

{% hint style="info" %} Include and Exclude Filtering Behaviour

Each filter supports include and exclude modes.

  • Include mode restricts results to matching APIs.

  • Exclude mode removes matching APIs from the result set.

The approach helps you precisely scope API discovery without modifying underlying API inventories. {% endhint %}

You can also delete an API collection. This is useful when you need to delete old or unused collections, for testing, development, or compliance purposes. For more, refer to this link.