Method: projects.locations.apis.list

Returns matching APIs.

HTTP request

GET https://apigeeregistry.googleapis.com/v1/{parent=projects/*/locations/*}/apis

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent, which owns this collection of APIs. Format: projects/*/locations/*

Query parameters

Parameters
pageSize

integer

The maximum number of APIs to return. The service may return fewer than this value. If unspecified, at most 50 values will be returned. The maximum is 1000; values above 1000 will be coerced to 1000.

pageToken

string

A page token, received from a previous apis.list call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to apis.list must match the call that provided the page token.

filter

string

An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields.

orderBy

string

A comma-separated list of fields, e.g. "foo,bar" Fields can be sorted in descending order using the "desc" identifier, e.g. "foo desc,bar"

Request body

The request body must be empty.

Response body

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

Response message for apis.list.

JSON representation
{
  "apis": [
    {
      object (Api)
    }
  ],
  "nextPageToken": string
}
Fields
apis[]

object (Api)

The APIs from the specified publisher.

nextPageToken

string

A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.

Authorization Scopes

Requires the following OAuth scope:

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