projects

POST /v1/projects/{projectsId}/locations/{locationsId}/externalApis

Changed on Nov 8, 2026

Create an External API resource in the API hub.

Request

Base URL
https://apihub.googleapis.com
Auth
- OAuth 2 and OAuth 2
  Implicithttps://accounts.google.com/o/oauth2/auth
  Scopeshttps://www.googleapis.com/auth/apihub.readwrite
  Authorization codehttps://accounts.google.com/o/oauth2/auth
  Token URLhttps://accounts.google.com/o/oauth2/token
  Scopeshttps://www.googleapis.com/auth/apihub.readwrite
- or OAuth 2 and OAuth 2
  Implicithttps://accounts.google.com/o/oauth2/auth
  Scopeshttps://www.googleapis.com/auth/cloud-platform
  Authorization codehttps://accounts.google.com/o/oauth2/auth
  Token URLhttps://accounts.google.com/o/oauth2/token
  Scopeshttps://www.googleapis.com/auth/cloud-platform
TypeScript
https://skmtc.dev/google/apis/apihub/docs/v1/projects/:projectsId/locations/:locationsId/externalApis/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

projectsIdstring required

locationsIdstring required

Query parameters

externalApiIdstring

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[0-9]-_/.

Request body

attributesobject

Optional. The list of user defined attributes associated with the Version resource. The key is the attribute name. It will be of the format: projects/{project}/locations/{location}/attributes/{attribute}. The value is the attribute values associated with the resource.

createTimestring google-datetime

Output only. Creation timestamp.

descriptionstring

Optional. Description of the external API. Max length is 500000 characters (Unicode Code Points).

displayNamestring

Required. Display name of the external API. Max length is 500 characters (Unicode Code Points).

endpointsstring[]

Optional. List of endpoints on which this API is accessible.

namestring

Identifier. Format: projects/{project}/locations/{location}/externalApi/{externalApi}.

pathsstring[]

Optional. List of paths served by this API.

updateTimestring google-datetime

Output only. Last update timestamp.

Response

Successful response