Ana içeriğe atla

​
Endpoint

GET /apiops/reports/api-proxies

​
Authentication

Requires a Personal API Access Token with admin or analyzer privileges. 
Authorization: Bearer YOUR_TOKEN

​
Request

​
Headers

HeaderValueRequired
AuthorizationBearer Yes

​
Path Parameters

None.

​
Query Parameters

ParameterTypeRequiredDescription
includeEndpointsbooleanNoWhether 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

FieldTypeDescription
successbooleanIndicates if the request was successful
resultListarray[object]List of API Proxy reports
resultCountintegerTotal number of API Proxies

​
API Proxy Report Object

FieldTypeDescription
idstringAPI Proxy ID
namestringAPI Proxy name
descriptionstringAPI Proxy description
typestringAPI Proxy type (REST, SOAP, etc.)
endpointsarray[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