Method: organizations.apiproducts.list

Lists all API product names for an organization. Filter the list by passing an attributename and attibutevalue.

The maximum number of API products returned is 1000. You can paginate the list of API products returned using the startKey and count query parameters.

If the resource has the space attribute set, the response may not return all resources. To learn more, read the Apigee Spaces Overview.

HTTP request

GET https://apigee.googleapis.com/v1/{parent=organizations/*}/apiproducts

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. Name of the organization. Use the following structure in your request: organizations/{org}

If the resource has the space attribute set, IAM permissions are checked against the Space resource path. To learn more, read the Apigee Spaces Overview.

Authorization requires the following IAM permission on the specified resource parent:

  • apigee.apiproducts.list

Query parameters

Parameters
attributename

string

Name of the attribute used to filter the search.
attributevalue

string

Value of the attribute used to filter the search.
expand

boolean

Flag that specifies whether to expand the results. Set to true to get expanded details about each API.
startKey

string

Gets a list of API products starting with a specific API product in the list. For example, if you're returning 50 API products at a time (using the count query parameter), you can view products 50-99 by entering the name of the 50th API product in the first API (without using startKey). Product name is case sensitive.
count

string (int64 format)

Enter the number of API products you want returned in the API call. The limit is 1000.
space

string

Optional. The Space to list API products for. When none provided, all the spaces the user has list access, will be used implicitly, and the same following rules will apply. Can be used in conjunction with startKey, expand and count for paginated response. Composite queries with attributename and attributevalue are not supported yet.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

JSON representation 
{
  "apiProduct": [
    {
      object (ApiProduct)
    }
  ]
}
Fields
apiProduct[]

object (ApiProduct)

Lists all API product names defined for an organization.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform