Method: projects.locations.externalApis.get

Get details about an External API resource in the API hub.

HTTP request


The URL uses gRPC Transcoding syntax.

Path parameters



Required. The name of the External API resource to retrieve. Format: projects/{project}/locations/{location}/externalApis/{externalApi}

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of ExternalApi.

Authorization scopes

Requires the following OAuth scope:


IAM Permissions

Requires the following IAM permission on the name resource:

  • apihub.externalApis.get

For more information, see the IAM documentation.