You are viewing the Apigee Management API reference documentation. For the main product docs, and to search all docs, go to https://docs.apigee.com.

List API Proxies

Resource Summary

Security

Content Type

application/x-www-form-urlencoded

Category

API Proxy,

listApiProxy

GET

List API Proxies

Gets the names of all API proxies in an organization. The names correspond to the names defined in the configuration files for each API proxy.

 

When using count and startKey, you typically make multiple API calls. The first call includes count to specify the number of elements to return:

curl -X GET -u email:password \
"https://api.enterprise.apigee.com/v1/organizations/{org_name}/apis?count=5" 

In this example, the call returns an array containing the first five APIs defined in the organization:

[ "API_1", "API_2", "API_3", "API_4", "API_5" ]

You then call the API a second time and specify both count and startKey, where startKey specifies the last array element from the previous call:

curl -X GET  -u email:password \
"https://api.enterprise.apigee.com/v1/organizations/{org_name}/apis?count=5&startKey=API_5"

This call returns an array containing the next five APIs defined in the organization, starting with API_5:

[ "API_5", "API_6", "API_7", "API_8", "API_9" ]

 

Resource URL

https://api.enterprise.apigee.com/v1 /organizations/{org_name}/apis

Query Parameters

Name Values Description
count

Specifies the number of elements to return. The maximum value is 100. By default, returns all API proxies.

startKey

Specifies the last element returned from the previous call to this API. The API then returns count number of elements starting from, and including, the element specified by startKey. You must specify count if you specify startKey.

Request Body

org_name Mention the organization name true

HTTP Basic

OAuth 2.0

API Key

Reset

Make a request and see the response.

Make a request and see the response.

Make a request and see the response.

Working...

Help or comments?

  • If something's not working: Ask the Apigee Community or see Apigee Support.
  • If something's wrong with the docs: Click the "Send Feedback" button.
    (Incorrect? Unclear? Broken link? Typo?)