Method: projects.locations.apis.list

List API resources in the API hub.

HTTP request

GET https://apihub.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 API resources. Format: projects/{project}/locations/{location}

Query parameters

Parameters
filter

string

Optional. An expression that filters the list of ApiResources.

A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string. The comparison operator must be one of: <, >, : or =. Filters are not case sensitive.

The following fields in the ApiResource are eligible for filtering:

  • owner.email - The email of the team which owns the ApiResource. Allowed comparison operators: =.
  • createTime - The time at which the ApiResource was created. The value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339] format. Allowed comparison operators: > and <.
  • displayName - The display name of the ApiResource. Allowed comparison operators: =.
  • targetUser.enum_values.values.id - The allowed value id of the target users attribute associated with the ApiResource. Allowed comparison operator is :.
  • team.enum_values.values.id - The allowed value id of the team attribute associated with the ApiResource. Allowed comparison operator is :.
  • businessUnit.enum_values.values.id - The allowed value id of the business unit attribute associated with the ApiResource. Allowed comparison operator is :.
  • maturityLevel.enum_values.values.id - The allowed value id of the maturity level attribute associated with the ApiResource. Allowed comparison operator is :.

Expressions are combined with either AND logic operator or OR logical operator but not both of them together i.e. only one of the AND or OR operator can be used throughout the filter string and both the operators cannot be used together. No other logical operators are supported. At most three filter fields are allowed in the filter string and if provided more than that then INVALID_ARGUMENT error is returned by the API.

Here are a few examples:

  • owner.email = \"apihub@google.com\" - - The owner team email is _apihub@google.com_.
  • owner.email = \"apihub@google.com\" AND createTime < \"2021-08-15T14:50:00Z\" AND createTime > \"2021-08-10T12:00:00Z\" - The owner team email is _apihub@google.com_ and the api was created before 2021-08-15 14:50:00 UTC and after 2021-08-10 12:00:00 UTC.
  • owner.email = \"apihub@google.com\" OR team.enum_values.values.id: apihub-team-id - The filter string specifies the APIs where the owner team email is _apihub@google.com_ or the id of the allowed value associated with the team attribute is apihub-team-id.
pageSize

integer

Optional. The maximum number of API resources to return. The service may return fewer than this value. If unspecified, at most 50 Apis 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 apis.list call. Provide this to retrieve the subsequent page.

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

Request body

The request body must be empty.

Response body

The apis.list method's response.

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

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

object (Api)

The API resources present in the API hub. Only following fields will be populated in the response: name, displayName, documentation.external_uri, team.enum_values.values.id and businessUnit.enum_values.values.id.
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.apis.list

For more information, see the IAM documentation.