# Inspect Schema of an API Collection

## Overview

Akto allows you to inspect the generated OpenAPI schema for every discovered API collection. Schema inspection helps security and platform teams review endpoint structure, parameters, and response formats associated with the collection.

## Navigation Path to the API Schema View

You can access the schema view using the following navigation path:

{% stepper %}
{% step %}
Navigate to **API Discovery** in the Akto API Security dashboard.
{% endstep %}

{% step %}
Open **API Collections**.
{% endstep %}

{% step %}
Select the required **API collection**.
{% endstep %}

{% step %}
Open **More Actions** in the top-right corner.
{% endstep %}

{% step %}
Under **Switch View**, select **View Schema**.

<div data-with-frame="true"><figure><img src="https://2916937215-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRc4KTKGprZI2sPWKoaLe%2Fuploads%2FrGX8NHRKgRnsAyBLUU6I%2FScreenshot%202026-03-10%20at%2011.58.33%20AM.webp?alt=media&#x26;token=91bfc3ff-a82f-4de3-83e7-588ddfad80f6" alt="" width="563"><figcaption></figcaption></figure></div>
{% endstep %}
{% endstepper %}

Akto opens the **API Schema Inspector** page for the selected collection.

## API Schema Inspector Interface

The API Schema Inspector page provides two synchronised views of the schema generated by Akto.

<div data-with-frame="true"><figure><img src="https://2916937215-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRc4KTKGprZI2sPWKoaLe%2Fuploads%2F2UTRWxo20hf2JUTHdd1N%2FScreenshot%202026-03-10%20at%2011.59.32%20AM.webp?alt=media&#x26;token=94c420bd-3061-4210-818c-c572a230c370" alt="" width="563"><figcaption></figcaption></figure></div>

### Raw OpenAPI Schema Panel

On the left side, the **Raw Schema** panel displays the complete OpenAPI specification in JSON format.

You can use the raw schema panel to:

* Review the generated **OpenAPI version and metadata**
* Inspect **server definitions**
* Examine **endpoint paths and operations**
* Validate **request parameters and headers**
* Analyse **response definitions**

{% hint style="info" %}
The raw schema panel also provides controls to **expand or collapse sections**, which helps when reviewing large schemas.
{% endhint %}

### Visual Documentation Panel

On the right side, the **Visual Documentation** panel presents the same OpenAPI schema in a structured, interactive format.

The visual documentation panel allows you to:

* Browse **all discovered API endpoints**
* View supported **HTTP methods**
* Inspect **request parameters**
* Review **response schemas and example payloads**
* Examine **response headers and status codes**

Each endpoint expands to show detailed request and response specifications.

#### Inspect Request Parameters and Headers

Selecting an endpoint in the visual documentation panel expands the request configuration.

The parameters section allows you to review:

* **Header parameters**
* **Query parameters**
* **Path parameters**
* **Parameter data types**
* **Example values**

<div data-with-frame="true"><figure><img src="https://2916937215-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRc4KTKGprZI2sPWKoaLe%2Fuploads%2FHmEvX96ejWNQd6VL684g%2FScreenshot%202026-03-10%20at%2012.00.50%20PM.webp?alt=media&#x26;token=57286a0d-5f14-43b8-b8dd-eafc492a190d" alt="" width="563"><figcaption></figcaption></figure></div>

Parameter visibility helps security teams verify how clients interact with the endpoint and what inputs the API expects.

#### Inspect Response Schema and Headers

The response section provides the response specification generated from observed API traffic.

The response panel displays:

* **HTTP response codes**
* **Response media types**
* **Example response payload**
* **Response schema**
* **Response headers**

<div data-with-frame="true"><figure><img src="https://2916937215-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRc4KTKGprZI2sPWKoaLe%2Fuploads%2FFn97JQaAN4g2oyopYztQ%2FScreenshot%202026-03-10%20at%2012.01.26%20PM.webp?alt=media&#x26;token=89d5303a-e960-46af-a120-dbea2fd63077" alt="" width="563"><figcaption></figcaption></figure></div>

Response inspection helps security teams understand the structure of returned data and identify sensitive data exposure risks.

## Result of API Schema Inspection

API schema inspection allows enterprise security teams to:

* Validate the API surface discovered by Akto
* Understand request and response structures
* Verify parameters accepted by each endpoint
* Analyze API behavior before running security tests

Schema visibility provides a structured representation of the API collection that supports security review and testing workflows.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.akto.io/api-inventory/how-to/inspect-schema-of-an-api-collection.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
