> For the complete documentation index, see [llms.txt](https://cortex-docs.paloaltonetworks.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://cortex-docs.paloaltonetworks.com/cortex-cloud-runtime-security/web-and-api-security-waas/secure-your-api-landscape/api-specification-inventory.md). # API specification inventory Cortex Cloud offers the option to import API specifications that comply with the [OpenAPI](https://www.openapis.org/) format, including format, file structure, and data types. In addition to observing API traffic, Cortex Cloud scans AWS and Azure API gateways, and extracts the API specification files. Once the specification files are in the inventory, Cortex Cloud scans them for misconfigurations and vulnerabilities, providing insights into your API landscape. Use Cortex Cloud to validate live traffic against specifications and alert on surface deviations, undocumented endpoints, or security gaps. The following table describes the fields that are available for each API specification. | Field | Description | | -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Sources |

Source of the API specification:

| | Asset Name | Asset name is obtained from the `title` field in the specification. | | Servers List |

This field is automatically filled if the specification contains the server URL or host. You must manually add the URL or host address if there is no URL or host in the specification.

Note

Even if you have already imported the specification, you can edit the API specification in Cortex Cloud and add or update the server list.

| | API Versions | API version obtained from the API specification. | | Associated Endpoints |

Shows the number of endpoints that match the specification.

You can right-click and select View Associated Endpoints to see the matched paths in the API Endpoints table.

| | Format & Version | OpenAPI or Swagger and the relative version. | | Spec File Name | Specification file name that was imported to Cortex Cloud. | | Findings | The total number of findings is broken down by severity, and findings with a severity of high trigger an issue. | | Status |

Indicates if the specification is:

| Click the API asset to open the side card. Each tab includes detailed information from the parsed data of the API. You can add **Comments** (![api\_specification\_comments.png](/files/wbmOSaQfZP7t8CDNu6O2)) to the specification, providing additional context about the API endpoints or other relevant information.
Overview Shows the highlights and properties of the API endpoint asset. | Field | Description | | --------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Asset ID | API asset ID. | | Provider |

Gateway provider:

| | Asset Category | API Endpoint or API Specification | | Account ID | Account ID of the API specification. | | Asset Groups | Indicates the asset group that the API is associated with. For more information, go to [Asset groups](/cortex-cloud-runtime-security/asset-managment/asset-groups.md). | | Cases/Issues/Findings |

The page shows issues and cases.

The link from the number opens the page where you can review the details. Refer to Issues, findings, and events for detailed information.

You can view all API security issues and cases detected by Cortex Cloud.

| | Evidence | Shows findings that provide visibility into the risks and vulnerabilities of your API landscape. By continuously analyzing findings, you can maintain an up-to-date view of the API asset’s security posture and support more informed decision-making for detection, prioritization, and remediation efforts. | An issue is generated when the following **Detection Method** is triggered. | Deployment option | Detection Method and Type | Description | | --------------------- | ----------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Agentless for Posture | **Detection Method**: API Posture Scanner |

If Cortex Cloud detects security vulnerabilities or compliance issues in the posture of an API during scanning, an issue is generated.

The issue includes specification static scan findings relevant to the issue.

|
Code The schema shows the actual API specification that includes the basic information of the API, the API path, method, and parameters.
Insights At a glance, we see a graphical representation of the specification scan results by severity and by category. You can filter in by severity or by category. Drill down to view details of the selected scan result. The specification scan results by severity table include the following information: | Field | Description | | ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Severity | Indicates the severity of the scan result issue. | | Category |

API category. The options are:

| | Name | Name of API specification. | | Description | Details of the scan results. | | Modification Time | Time stamp of when the API specification was modified | | Finding ID | For every vulnerability, a finding is created. | You can drill down by clicking a severity to see the details/information of the findings (vulnerabilities). | Field | Description | | ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | | Severity | | | Category | API category. | | Link to OpenAPI checks | .[OpenAPI](https://www.openapis.org/) page of the scan results item includes a description of the issue and a link to **Details** You can: | | Description | Details of the scan results. | | Scan Result Issue | Refers to the number of findings. | | Scan Results | Shows the findings in the API request. The issue is highlighted. |
**Import API specification** Cortex Cloud enables you to import YAML or JSON files. After importing the file, Cortex Cloud analyzes the data to identify vulnerabilities to help you effectively manage and enforce security measures. **How to import an API Specification** 1. Go to Inventory → All Assets → APIs → **Specification**. 2. Click **Import API Specification**. 3. Drop or browse for the API specification file and add the server of where the file is hosted. This field is automatically filled if the file contains the server URL or host. If there is no URL or host in the file, you must manually add the URL or host address.

Note

Even if you already imported the file, you can edit the API asset and add or update the server list.

4. Click **Import**. It can take up to 30 minutes to import the file. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## 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, and the optional `goal` query parameter: ``` GET https://cortex-docs.paloaltonetworks.com/cortex-cloud-runtime-security/web-and-api-security-waas/secure-your-api-landscape/api-specification-inventory.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. 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.