Ana içeriğe atla

​
Endpoint

GET /apiops/projects/{projectName}/apiProxies/{apiProxyName}/policies/

​
Authentication

Requires a Personal API Access Token. 
Authorization: Bearer YOUR_TOKEN

​
Request

​
Headers

HeaderValueRequired
AuthorizationBearer Yes

​
Path Parameters

ParameterTypeRequiredDescription
projectNamestringYesProject name
apiProxyNamestringYesAPI Proxy name

​
Query Parameters

None

​
Response

​
Success Response (200 OK)

{
  "status": "SUCCESS",
  "resultList": [
    {
      "name": "Address",
      "type": "SOAP",
      "relativePath": "/address",
      "soapToRest": false,
      "requestPolicyList": [
        {
          "type": "policy-throttling",
          "active": true
        }
      ],
      "responsePolicyList": [
        {
          "type": "policy-api-call",
          "active": true
        }
      ],
      "errorPolicyList": [
        {
          "type": "policy-script",
          "active": true
        },
        {
          "type": "policy-script",
          "description": "sample description",
          "active": true
        }
      ],
      "endpointList": [
        {
          "endpoint": "/UpdateAddress",
          "active": true,
          "httpMethod": "POST",
          "requestPolicyList": [
            {
              "type": "policy-script",
              "active": true
            }
          ]
        }
      ]
    }
  ],
  "resultCount": 1
}

​
Response Fields

FieldTypeDescription
statusstringResponse status: SUCCESS or FAILURE
resultListarrayList containing API proxy with policies
resultCountintegerTotal number of results (always 1)

​
API Proxy Object Fields

FieldTypeDescription
namestringAPI Proxy name
typestringAPI type. See EnumApiType
relativePathstringRelative path (from clientRoute)
soapToRestbooleanWhether SOAP to REST transformation is enabled
requestPolicyListarrayList of request pipeline policies
responsePolicyListarrayList of response pipeline policies
errorPolicyListarrayList of error pipeline policies
endpointListarrayList of endpoints with their policies

​
EnumApiType

  • REST - REST API
  • SOAP - SOAP API

​
EnumStatus

  • SUCCESS - Operation successful
  • FAILURE - Operation failed

​
Error Response (401 Unauthorized)

{
  "error": "unauthorized_client",
  "error_description": "Invalid token"
}

​
Error Response (404 Not Found)

{
  "error": "not_found",
  "error_description": "Project 'MyProject' not found"
}

​
cURL Example

curl -X GET \
  "https://demo.apinizer.com/apiops/projects/MyProject/apiProxies/MyAPI/policies/" \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Full JSON Body Example

This endpoint does not require a request body.

​
Permissions

  • User must have any permission in the project (read access)

​
Notes and Warnings

  • Policy Details: Policy details may be simplified in list responses. Use individual policy endpoints for full details.
  • Pipeline Organization: Policies are organized by pipeline (request, response, error).
  • Empty Lists: If no policies exist in a pipeline, an empty array is returned.