Method: projects.locations.externalApis.create

Create an External API resource in the API hub.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent resource for the External API resource. Format: projects/{project}/locations/{location}

Query parameters

Parameters
externalApiId

string

Optional. The ID to use for the External API resource, which will become the final component of the External API's resource name. This field is optional.

  • If provided, the same will be used. The service will throw an error if the specified id is already used by another External API resource in the API hub.
  • If not provided, a system generated id will be used.

This value should be 4-500 characters, and valid characters are /[a-z][A-Z][0-9]-_/.

Request body

The request body contains an instance of ExternalApi.

Response body

If successful, the response body contains a newly created instance of ExternalApi.

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.create

For more information, see the IAM documentation.