Get API List (Reserved)

Overview

Retrieve a list of APIs for a given application. This endpoint allows you to browse and filter the API inventory of your application. You can filter the results by API name, type, and method, and use pagination parameters to manage large result sets.

URI

GET /rest/applications/{application}/api/list

Path parameters

application (string)

This parameter identifies the analyzed application. The application name must be properly encoded if required. Character back-quote is not allowed.

Query parameters

name (string)

optional, default: "" Filter results by API name. When omitted or empty, returns all API names.

type (string)

optional, default: "" Filter results by API type (e.g., “Public”, “Private”). When omitted or empty, returns all API types.

method (string)

optional, default: "" Filter results by method (e.g., GET, PUT, POST, DELETE). When omitted or empty, returns all methods.

limit (integer)

required The maximum number of APIs to return in the response.

skip (integer)

optional, default: 0 The number of APIs to skip for pagination purposes. Use in combination with limit to navigate through large result sets.

Responses

application/json

The response contains a paginated list of APIs with their basic information. Example:

{
    "total": 1,
    "limit": 100,
    "skip": 0,
    "results": [
        {
            "id": "462488",
            "name": "*.jsp/",
            "fullName": "org.openmrs.module.web.OpenmrsJspServlet.service/*.jsp/ANY",
            "type": "Public",
            "method": "Servlet Any Operation"
        }
    ]
}

JSON representation

API Summary

Each API in the results array contains: