Ana içeriğe atla

Documentation Index

Fetch the complete documentation index at: https://docs.apinizer.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Endpoint

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

​
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

ParameterTypeRequiredDefaultDescription
withPoliciesbooleanNofalseWhen set to true, policy details (request, response, error pipelines) are included for each method

​
Response

​
Success Response (200 OK)

​
Without Policies (default)

{
  "success": true,
  "resultList": [
    {
      "id": "endpoint-id-1",
      "endpoint": "/api/users",
      "description": "Get all users",
      "active": true,
      "httpMethod": "GET",
      "backendResourceUrl": "/users",
      "backendHttpMethod": "GET"
    },
    {
      "id": "endpoint-id-2",
      "endpoint": "/api/users",
      "description": "Create user",
      "active": true,
      "httpMethod": "POST",
      "backendResourceUrl": "/users",
      "backendHttpMethod": "POST"
    }
  ],
  "resultCount": 2
}

​
With Policies (withPolicies=true)

{
  "success": true,
  "resultList": [
    {
      "id": "endpoint-id-1",
      "endpoint": "/api/users",
      "description": "Get all users",
      "active": true,
      "httpMethod": "GET",
      "backendResourceUrl": "/users",
      "backendHttpMethod": "GET",
      "requestPolicyList": [
        {
          "type": "policy-api-based-throttling",
          "name": "throttling-policy",
          "description": "Throttling policy",
          "active": true
        }
      ],
      "responsePolicyList": [],
      "errorPolicyList": []
    }
  ],
  "resultCount": 1
}

​
Response Fields

FieldTypeDescription
successbooleanIndicates if the request was successful
resultListarrayList of method (endpoint) objects
resultCountintegerTotal number of methods

​
Method Object Fields

FieldTypeDescription
idstringMethod unique identifier
endpointstringMethod path/name
descriptionstringMethod description
activebooleanWhether method is active/enabled
httpMethodstringHTTP method (GET, POST, PUT, DELETE, PATCH, etc.)
backendResourceUrlstringBackend resource URL
backendHttpMethodstringHTTP method for backend call
requestPolicyListarrayList of request pipeline policies (only when withPolicies=true)
responsePolicyListarrayList of response pipeline policies (only when withPolicies=true)
errorPolicyListarrayList of error pipeline policies (only when withPolicies=true)

​
EnumHttpRequestMethod

  • GET, POST, PUT, DELETE, PATCH, OPTIONS, HEAD, TRACE, ALL

​
Error Response (401 Unauthorized)

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

​
Error Response (400 Bad Request)

{
  "error": "bad_request",
  "error_description": "ApiProxy (name: MyAPI) is not found!"
}

​
cURL Example

​
Without Policies

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

​
With Policies

curl -X GET \
  "https://demo.apinizer.com/apiops/projects/MyProject/apiProxies/MyAPI/methods/?withPolicies=true" \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Full JSON Body Example

This endpoint does not require a request body.

​
Permissions

User must have API_MANAGEMENT + VIEW permission in the project.

​
Notes and Warnings

  • Difference from List Endpoints: This endpoint uses the /methods/ path and supports the withPolicies query parameter for inline policy retrieval
  • Policy Details: By default, policy lists are not included to reduce response size. Set withPolicies=true to include policies
  • Empty List: If no methods exist, an empty resultList is returned with resultCount: 0
  • API Proxy Type: Works for both REST and SOAP API proxies