Method: projects.locations.externalApis.list

List External API resources in the API hub.

HTTP request

GET https://apihub.googleapis.com/v1/{parent=projects/*/locations/*}/externalApis

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent, which owns this collection of External API resources. Format: projects/{project}/locations/{location}

Query parameters

Parameters
pageSize

integer

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

string

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

When paginating, all other parameters (except pageSize) provided to externalApis.list must match the call that provided the page token.

Request body

The request body must be empty.

Response body

The externalApis.list method's response.

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

JSON representation 
{
  "externalApis": [
    {
      object (ExternalApi)
    }
  ],
  "nextPageToken": string
}
Fields
externalApis[]

object (ExternalApi)

The External API resources present in the API hub. Only following fields will be populated in the response: name, displayName, documentation.external_uri.
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

IAM Permissions

Requires the following IAM permission on the parent resource:

  • apihub.externalApis.list

For more information, see the IAM documentation.