API Report

Retrieves a comprehensive report of all API Proxies and API Proxy Groups with detailed metadata. This report includes information about API configurations, endpoints, and other relevant details.

​

Endpoint

GET /apiops/reports/api-proxies

​

Authentication

Requires a Personal API Access Token with admin or analyzer privileges.

​

Header

Authorization: Bearer YOUR_TOKEN

​

Request

​

Headers

Header	Value	Required
Authorization	Bearer	Yes

​

Path Parameters

None.

​

Query Parameters

Parameter	Type	Required	Description
includeEndpoints	boolean	No	Whether to include endpoint details in the report

​

Notes

• includeEndpoints=true - Includes detailed endpoint information
• includeEndpoints=false or omitted - Excludes endpoint details (faster response)

​

Response

​

Success Response (200 OK)

{
  "success": true,
  "resultList": [
    {
      "id": "api-proxy-id",
      "name": "MyAPI",
      "description": "My API description",
      "type": "REST",
      "endpoints": [
        {
          "id": "endpoint-id",
          "name": "GET /users",
          "method": "GET",
          "path": "/users"
        }
      ]
    }
  ],
  "resultCount": 1
}

​

Response Fields

Field	Type	Description
success	boolean	Indicates if the request was successful
resultList	array[object]	List of API Proxy reports
resultCount	integer	Total number of API Proxies

​

API Proxy Report Object

Field	Type	Description
id	string	API Proxy ID
name	string	API Proxy name
description	string	API Proxy description
type	string	API Proxy type (REST, SOAP, etc.)
endpoints	array[object]	List of endpoints (if includeEndpoints=true)

​

Notes

• Response structure may vary based on includeEndpoints parameter
• Empty list ([]) is returned if no API Proxies exist
• Only accessible by sysAdmin or sysAnalyzer users

​

Error Response (401 Unauthorized)

{
  "error": "unauthorized_client",
  "error_description": "Unauthorized API Access!"
}

​

cURL Example

​

Example 1: Get API Report without Endpoints

curl -X GET \
  "https://demo.apinizer.com/apiops/reports/api-proxies" \
  -H "Authorization: Bearer YOUR_TOKEN"

​

Example 2: Get API Report with Endpoints

curl -X GET \
  "https://demo.apinizer.com/apiops/reports/api-proxies?includeEndpoints=true" \
  -H "Authorization: Bearer YOUR_TOKEN"

​

Permissions

• User must have system admin (sysAdmin) or system analyzer (sysAnalyzer) role

​

Notes and Warnings

• Admin/Analyzer Only:
  • This endpoint requires sysAdmin or sysAnalyzer privileges
  • Regular users cannot access this endpoint
• Performance:
  • Including endpoints (includeEndpoints=true) may result in slower response
  • Use includeEndpoints=false for faster responses
• Large Datasets:
  • Response may be large for projects with many API Proxies
  • Consider pagination or filtering if needed

​

Related Documentation

• Organization API Data Model Access Report - Organization-level access report