List Methods

Endpoint

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

Authentication

Requires a Personal API Access Token.

Header

Authorization: Bearer YOUR_TOKEN

Request

Headers

Header	Value	Required
Authorization	Bearer {token}	Yes

Path Parameters

Parameter	Type	Required	Description
projectName	string	Yes	Project name
apiProxyName	string	Yes	API Proxy name

Query Parameters

Parameter	Type	Required	Default	Description
withPolicies	boolean	No	false	When 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

Field	Type	Description
success	boolean	Indicates if the request was successful
resultList	array	List of method (endpoint) objects
resultCount	integer	Total number of methods

Method Object Fields

Field	Type	Description
id	string	Method unique identifier
endpoint	string	Method path/name
description	string	Method description
active	boolean	Whether method is active/enabled
httpMethod	string	HTTP method (GET, POST, PUT, DELETE, PATCH, etc.)
backendResourceUrl	string	Backend resource URL
backendHttpMethod	string	HTTP method for backend call
requestPolicyList	array	List of request pipeline policies (only when withPolicies=true)
responsePolicyList	array	List of response pipeline policies (only when withPolicies=true)
errorPolicyList	array	List of error pipeline policies (only when withPolicies=true)

EnumHttpRequestMethod

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

Error Response (401 Unauthorized)

{
  "status": "FAILURE",
  "resultMessage": "Token is not valid!"
}

Error Response (400 Bad Request)

{
  "status": "FAILURE",
  "resultMessage": "ApiProxy (name: MyAPI) was 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

Related Documentation

• List Endpoints - List all endpoints (without withPolicies option)
• Get Method Policies - Get policies for a specific method
• Get API Proxy Detail - Get full API proxy details with endpoints