Send Docs Feedback

Making management API calls from this page

  1. In the URL, replace any values indicated by "{ }", such as your organization name.
  2. Set the Basic Authentication credentials: Edge email and password (user must be in the Org Admin role).
    If you don't have an Apigee account,
    go here.
  3. Tweak the parameters and request body as needed.
  4. Send the live request to Edge!

List App IDs in an App Family

Resource Summary

Security

Content Type

appliction/json, text/xml

Category

Apps,

listAppsFamily

GET

List App IDs in an App Family

Lists, by ID, all apps contained in an app family.

Resource URL

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

Query Parameters

Name Values Description
appfamily
(required)

The app family name

startKey

CPS This parameter can only be used in organizations with Core Persistence Services enabled.

To filter the apps that are returned, enter the ID of an app that the list will start with. For example, if the an unfiltered list returns:

"ddce5dff-d0b7-4c91-9be1-ac586ea99a8e",
"e8fd6a3d-f88c-462e-a4ec-41cf886f12b7",
"f1360a60-d927-42ff-8c86-1466e6546b39"

and your startKey is e8fd6a3d-f88c-462e-a4ec-41cf886f12b7, the returned list will be:

"e8fd6a3d-f88c-462e-a4ec-41cf886f12b7",
"f1360a60-d927-42ff-8c86-1466e6546b39"

rows

Limits the list to the number you specify. Use with the startKey parameter to provide more targeted filtering. The limit is 10000.

CPS For Core Persistence Services, the limit is 1000.

Request Body

org_name Mention the organization name true

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?