API Report

Endpoint

GET /apiops/reports/api-proxies

Authentication

Requires a Personal API Access Token. Caller must have system admin (sysAdmin) or system analyzer (sysAnalyzer).

Header

Authorization: Bearer YOUR_TOKEN

Request

Headers

Header	Value	Required
Authorization	Bearer {token}	Yes

Path Parameters

None.

Query Parameters

Parameter	Type	Required	Description
includeEndpoints	boolean	No	When true, includes endpointList per API Proxy. When omitted or false, endpoint details are excluded

Notes

• includeEndpoints=true adds method-level details (endpointList)
• Omitting the parameter or includeEndpoints=false returns a lighter response
• Includes both standalone API Proxies and API Proxy Groups (apiGroup: true)
• Response is not paginated

Response

Success Response (200 OK)

{
  "status": "SUCCESS",
  "resultList": [
    {
      "apiName": "MyAPI",
      "description": "My API description",
      "apiType": "REST",
      "projectName": "MyProject",
      "apiGroup": false,
      "deployed": true,
      "apiUrlList": ["https://api.example.com/my-api"],
      "authenticationExist": true,
      "authenticationTypeList": ["API_AUTHENTICATION"],
      "rateLimitExist": false,
      "endpointList": [
        {
          "endpoint": "GET /users",
          "description": "List users",
          "active": true,
          "httpMethod": "GET",
          "backendResourceUrl": "/users",
          "backendHttpMethod": "GET"
        }
      ]
    }
  ],
  "resultCount": 1
}

Response Fields

Field	Type	Description
status	string	"SUCCESS" when the request completes successfully
resultList	array[object]	List of API Proxy / API Proxy Group report objects
resultCount	integer	Number of items in resultList

Report Object (resultList item)

Field	Type	Description
apiName	string	API Proxy or API Proxy Group name
description	string	Description
apiType	string	API type (REST, SOAP, …)
projectName	string	Owning project name
apiGroup	boolean	true for API Proxy Group entries
apiIdListOfApiGroup	array[string]	Member API Proxy IDs (when apiGroup=true)
deployed	boolean	Whether deployed to at least one environment
environmentList	array[object]	Per-environment deployment info (environmentName, accessUrl, deployed, redeployRequired)
apiUrlList	array[string]	Gateway access URLs
apiSpecUrlList	array[string]	Spec URLs (?openapi / ?wsdl) when spec is not hidden
specFileHidden	boolean	Whether the spec file is hidden
clientRoute	object	Client route configuration
protocolTransformation	boolean	Protocol transformation enabled
apiCategories	array[string]	Category labels
routingAddressList	array[string]	Upstream routing addresses
routingConnectionTimeout	integer	Routing connect timeout (ms)
routingReadTimeout	integer	Routing read timeout (ms)
backendSpecUrl	string	Imported backend spec URL
backendSpecFileName	string	Imported backend spec file name
authenticationExist	boolean	Request authentication policy present
authenticationTypeList	array[string]	Authentication policy type names
rateLimitExist	boolean	Rate limit policy present
endpointList	array[object]	Method list (only when includeEndpoints=true)

Endpoint Object (endpointList item)

Field	Type	Description
endpoint	string	Method identifier / path label
description	string	Method description
active	boolean	Whether the method is active
httpMethod	string	Client HTTP method
backendResourceUrl	string	Backend resource path
backendHttpMethod	string	Backend HTTP method

Notes

• endpointList is populated only when includeEndpoints=true
• Empty resultList ([]) is returned when no API Proxies exist
• resultCount may be 0 for empty results

Error Response (401 Unauthorized)

Missing/invalid token or caller without sysAdmin / sysAnalyzer:

{
  "status": "FAILURE",
  "resultMessage": "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). See Reports API.

Notes and Warnings

• Admin/Analyzer only:

  • Regular project users receive HTTP 401 with Unauthorized API Access!

• Performance:

  • includeEndpoints=true increases payload size and processing time

• No pagination:

  • The endpoint returns the full inventory in a single response

Related Documentation

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