# getApiSecurityInput

Input parameters for retrieving API security items with filtering and pagination.

### Examples

```graphql
input GetApiSecurityInput {
  scanId: String
  offset: Int
  limit: Int
  owners: [String]
  tagIds: [String]
  search: String
  filters: ApiSecFilters
  filterSearch: [AutoCompleteSearch]
  openItems: [FilterTypes]
  orderBy: ApiSecurityOrderBy
}
```

### Fields

| Field                                                                                                                         | Description                                             | Supported fields                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| ----------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| scanId `String`                                                                                                               | Specific scan identifier to retrieve APIs from          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| offset `Int`                                                                                                                  | Number of items to skip for pagination                  |                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| limit `Int`                                                                                                                   | Maximum number of items to return                       |                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| owners `[String]`                                                                                                             | Filter by application owners                            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| tagIds `[String]`                                                                                                             | Filter by tag identifiers for role-based access control |                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| search `String`                                                                                                               | Text search across API endpoints                        |                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| filters [`ApiSecFilters`](/api-documentation/api-reference/api--api-security/types/inputs/api-sec-filters.md)                 | Structured filters to apply to the API search           | <p>apps <code>\[String]</code><br>appIds <code>\[String]</code><br>titles <code>\[String]</code><br>endpoints <code>\[String]</code><br>methods <code>\[String]</code><br>framework <code>\[String]</code><br>languages <code>\[String]</code><br>issueIds <code>\[String]</code><br>apiId <code>\[String]</code><br>source <code>\[String]</code><br>severities <code>\[String]</code><br>reachability <code>\[String]</code><br>appTags <code>\[String]</code></p> |
| filterSearch [`[AutoCompleteSearch]`](/api-documentation/api-reference/api--application/types/inputs/auto-complete-search.md) | Advanced search filters with autocomplete support       | <p>fieldName <code>String</code><br>value <code>\[String]</code></p>                                                                                                                                                                                                                                                                                                                                                                                                 |
| openItems [`[FilterTypes]`](/api-documentation/api-reference/api--application/types/enums/filter-types.md)                    | Filter for items that are currently open or active      |                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| orderBy [`ApiSecurityOrderBy`](/api-documentation/api-reference/api--api-security/types/inputs/api-security-order-by.md)      | Sorting configuration for the results                   | <p>field <code>String</code><br>direction <a href="/pages/MShdjanlfhzp71ZokzYR"><code>Direction</code></a></p>                                                                                                                                                                                                                                                                                                                                                       |

### References

#### Queries using this object:

* [\<?> getApiSecurityItems.getApiSecurityInput](/api-documentation/api-reference/api--api-security/queries/get-api-security-items.md)
* [\<?> getApiSecurityFiltersLazy.getApiSecurityInput](/api-documentation/api-reference/api--api-security/queries/get-api-security-filters-lazy.md)


---

# 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.ox.security/api-documentation/api-reference/api--api-security/types/inputs/get-api-security-input.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.
