Sign in

v2

latestOpenAPI 3.0.3Apache 2.0raw.githubusercontent.com2026-07-21130282381.6 KB
APIs

Search APIs

Search APIs

Search APIs for a specific environment.<br> The results are paginated and can be sorted.

post/environments/{envId}/apis/_search

Query parameters

pageinteger

The page number for pagination.

perPageinteger

The number of items per page for pagination.

sortBy'name' | '-name' | 'api_type' | '-api_type' | 'status' | '-status' | 'paths' | '-paths' | 'tags_asc' | '-tags_desc' | 'categories_asc' | '-categories_desc' | 'owner' | '-owner' | 'visibility' | '-visibility'
Example:name

Possibility to sort APIs results by field. Can be ascending or descending with minus '-' prefix. By default, no sort is applied.

expandsstring[]

Expansion of data to return in APIs.

manageOnlyboolean

By default only APIs that the user can manage are returned. If set to false, all APIs that the user can view are returned.

Request body

querystring

The query to search for.

idsstring[]

List of ids to find

definitionVersion'V2' | 'V4' | 'FEDERATED' | 'FEDERATED_AGENT'

API's gravitee definition version.

definitionVersionsDefinitionVersion[]
apiTypesstring[]
statusesstring[]
tagsstring[]
categoriesstring[]
publishedstring[]
visibilitiesstring[]
allowedInApiProductsboolean

When set, filters results to only APIs with this allowedInApiProducts value. When true, only returns APIs allowed in API Products. When false, only returns APIs not allowed in API Products. Only applicable for V4 HTTP Proxy APIs.

hasOpenApiDocumentationboolean

When set, filters results based on whether the API has at least one published OpenAPI/Swagger documentation page. When true, only returns APIs that publish an OpenAPI documentation page. When false, only returns APIs without one.

Example request

{
  "query": "my api",
  "ids": [
    "apiId-1",
    "apiId-2"
  ],
  "definitionVersion": "V4",
  "definitionVersions": [
    "V4"
  ],
  "allowedInApiProducts": true,
  "hasOpenApiDocumentation": true
}

Response

Page of apis