API hub API

Service: apihub.googleapis.com

To call this service, we recommend that you use the Google-provided client libraries. If your application needs to use your own libraries to call this service, use the following information when you make the API requests.

Service endpoint

A service endpoint is a base URL that specifies the network address of an API service. One service might have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:

  • https://apihub.googleapis.com

REST Resource: v1.projects.locations

Methods
collectApiData POST /v1/{location=projects/*/locations/*}:collectApiData
Collect API data from a source and push it to Hub's collect layer.
get GET /v1/{name=projects/*/locations/*}
Gets information about a location.
list GET /v1/{name=projects/*}/locations
Lists information about the supported locations for this service.
lookupRuntimeProjectAttachment GET /v1/{name=projects/*/locations/*}:lookupRuntimeProjectAttachment
Look up a runtime project attachment.
searchResources POST /v1/{location=projects/*/locations/*}:searchResources
Search across API-Hub resources.

REST Resource: v1.projects.locations.apiHubInstances

Methods
create POST /v1/{parent=projects/*/locations/*}/apiHubInstances
Provisions instance resources for the API hub.
delete DELETE /v1/{name=projects/*/locations/*/apiHubInstances/*}
Deletes the API hub instance.
get GET /v1/{name=projects/*/locations/*/apiHubInstances/*}
Gets details of a single API hub instance.
lookup GET /v1/{parent=projects/*/locations/*}/apiHubInstances:lookup
Looks up an Api Hub instance in a given Google Cloud project.

REST Resource: v1.projects.locations.apis

Methods
create POST /v1/{parent=projects/*/locations/*}/apis
Create an API resource in the API hub.
delete DELETE /v1/{name=projects/*/locations/*/apis/*}
Delete an API resource in the API hub.
get GET /v1/{name=projects/*/locations/*/apis/*}
Get API resource details including the API versions contained in it.
list GET /v1/{parent=projects/*/locations/*}/apis
List API resources in the API hub.
patch PATCH /v1/{api.name=projects/*/locations/*/apis/*}
Update an API resource in the API hub.

REST Resource: v1.projects.locations.apis.versions

Methods
create POST /v1/{parent=projects/*/locations/*/apis/*}/versions
Create an API version for an API resource in the API hub.
delete DELETE /v1/{name=projects/*/locations/*/apis/*/versions/*}
Delete an API version.
get GET /v1/{name=projects/*/locations/*/apis/*/versions/*}
Get details about the API version of an API resource.
list GET /v1/{parent=projects/*/locations/*/apis/*}/versions
List API versions of an API resource in the API hub.
patch PATCH /v1/{version.name=projects/*/locations/*/apis/*/versions/*}
Update API version.

REST Resource: v1.projects.locations.apis.versions.definitions

Methods
get GET /v1/{name=projects/*/locations/*/apis/*/versions/*/definitions/*}
Get details about a definition in an API version.

REST Resource: v1.projects.locations.apis.versions.operations

Methods
create POST /v1/{parent=projects/*/locations/*/apis/*/versions/*}/operations
Create an apiOperation in an API version.
delete DELETE /v1/{name=projects/*/locations/*/apis/*/versions/*/operations/*}
Delete an operation in an API version and we can delete only the operations created via create API.
get GET /v1/{name=projects/*/locations/*/apis/*/versions/*/operations/*}
Get details about a particular operation in API version.
list GET /v1/{parent=projects/*/locations/*/apis/*/versions/*}/operations
List operations in an API version.
patch PATCH /v1/{apiOperation.name=projects/*/locations/*/apis/*/versions/*/operations/*}
Update an operation in an API version.

REST Resource: v1.projects.locations.apis.versions.specs

Methods
create POST /v1/{parent=projects/*/locations/*/apis/*/versions/*}/specs
Add a spec to an API version in the API hub.
delete DELETE /v1/{name=projects/*/locations/*/apis/*/versions/*/specs/*}
Delete a spec.
get GET /v1/{name=projects/*/locations/*/apis/*/versions/*/specs/*}
Get details about the information parsed from a spec.
getContents GET /v1/{name=projects/*/locations/*/apis/*/versions/*/specs/*}:contents
Get spec contents.
lint POST /v1/{name=projects/*/locations/*/apis/*/versions/*/specs/*}:lint
Lints the requested spec and updates the corresponding API Spec with the lint response.
list GET /v1/{parent=projects/*/locations/*/apis/*/versions/*}/specs
List specs corresponding to a particular API resource.
patch PATCH /v1/{spec.name=projects/*/locations/*/apis/*/versions/*/specs/*}
Update spec.

REST Resource: v1.projects.locations.attributes

Methods
create POST /v1/{parent=projects/*/locations/*}/attributes
Create a user defined attribute.
delete DELETE /v1/{name=projects/*/locations/*/attributes/*}
Delete an attribute.
get GET /v1/{name=projects/*/locations/*/attributes/*}
Get details about the attribute.
list GET /v1/{parent=projects/*/locations/*}/attributes
List all attributes.
patch PATCH /v1/{attribute.name=projects/*/locations/*/attributes/*}
Update the attribute.

REST Resource: v1.projects.locations.curations

Methods
create POST /v1/{parent=projects/*/locations/*}/curations
Create a curation resource in the API hub.
delete DELETE /v1/{name=projects/*/locations/*/curations/*}
Delete a curation resource in the API hub.
get GET /v1/{name=projects/*/locations/*/curations/*}
Get curation resource details.
list GET /v1/{parent=projects/*/locations/*}/curations
List curation resources in the API hub.
patch PATCH /v1/{curation.name=projects/*/locations/*/curations/*}
Update a curation resource in the API hub.

REST Resource: v1.projects.locations.dependencies

Methods
create POST /v1/{parent=projects/*/locations/*}/dependencies
Create a dependency between two entities in the API hub.
delete DELETE /v1/{name=projects/*/locations/*/dependencies/*}
Delete the dependency resource.
get GET /v1/{name=projects/*/locations/*/dependencies/*}
Get details about a dependency resource in the API hub.
list GET /v1/{parent=projects/*/locations/*}/dependencies
List dependencies based on the provided filter and pagination parameters.
patch PATCH /v1/{dependency.name=projects/*/locations/*/dependencies/*}
Update a dependency based on the update_mask provided in the request.

REST Resource: v1.projects.locations.deployments

Methods
create POST /v1/{parent=projects/*/locations/*}/deployments
Create a deployment resource in the API hub.
delete DELETE /v1/{name=projects/*/locations/*/deployments/*}
Delete a deployment resource in the API hub.
get GET /v1/{name=projects/*/locations/*/deployments/*}
Get details about a deployment and the API versions linked to it.
list GET /v1/{parent=projects/*/locations/*}/deployments
List deployment resources in the API hub.
patch PATCH /v1/{deployment.name=projects/*/locations/*/deployments/*}
Update a deployment resource in the API hub.

REST Resource: v1.projects.locations.externalApis

Methods
create POST /v1/{parent=projects/*/locations/*}/externalApis
Create an External API resource in the API hub.
delete DELETE /v1/{name=projects/*/locations/*/externalApis/*}
Delete an External API resource in the API hub.
get GET /v1/{name=projects/*/locations/*/externalApis/*}
Get details about an External API resource in the API hub.
list GET /v1/{parent=projects/*/locations/*}/externalApis
List External API resources in the API hub.
patch PATCH /v1/{externalApi.name=projects/*/locations/*/externalApis/*}
Update an External API resource in the API hub.

REST Resource: v1.projects.locations.hostProjectRegistrations

Methods
create POST /v1/{parent=projects/*/locations/*}/hostProjectRegistrations
Create a host project registration.
get GET /v1/{name=projects/*/locations/*/hostProjectRegistrations/*}
Get a host project registration.
list GET /v1/{parent=projects/*/locations/*}/hostProjectRegistrations
Lists host project registrations.

REST Resource: v1.projects.locations.operations

Methods
cancel POST /v1/{name=projects/*/locations/*/operations/*}:cancel
Starts asynchronous cancellation on a long-running operation.
delete DELETE /v1/{name=projects/*/locations/*/operations/*}
Deletes a long-running operation.
get GET /v1/{name=projects/*/locations/*/operations/*}
Gets the latest state of a long-running operation.
list GET /v1/{name=projects/*/locations/*}/operations
Lists operations that match the specified filter in the request.

REST Resource: v1.projects.locations.plugins

Methods
create POST /v1/{parent=projects/*/locations/*}/plugins
Create an API hub plugin resource in the API hub.
delete DELETE /v1/{name=projects/*/locations/*/plugins/*}
Delete a Plugin in API hub.
disable POST /v1/{name=projects/*/locations/*/plugins/*}:disable
Disables a plugin.
enable POST /v1/{name=projects/*/locations/*/plugins/*}:enable
Enables a plugin.
get GET /v1/{name=projects/*/locations/*/plugins/*}
Get an API hub plugin.
getStyleGuide GET /v1/{name=projects/*/locations/*/plugins/*/styleGuide}
Get the style guide being used for linting.
list GET /v1/{parent=projects/*/locations/*}/plugins
List all the plugins in a given project and location.
updateStyleGuide PATCH /v1/{styleGuide.name=projects/*/locations/*/plugins/*/styleGuide}
Update the styleGuide to be used for liniting in by API hub.

REST Resource: v1.projects.locations.plugins.instances

Methods
create POST /v1/{parent=projects/*/locations/*/plugins/*}/instances
Creates a Plugin instance in the API hub.
delete DELETE /v1/{name=projects/*/locations/*/plugins/*/instances/*}
Deletes a plugin instance in the API hub.
disableAction POST /v1/{name=projects/*/locations/*/plugins/*/instances/*}:disableAction
Disables a plugin instance in the API hub.
enableAction POST /v1/{name=projects/*/locations/*/plugins/*/instances/*}:enableAction
Enables a plugin instance in the API hub.
executeAction POST /v1/{name=projects/*/locations/*/plugins/*/instances/*}:executeAction
Executes a plugin instance in the API hub.
get GET /v1/{name=projects/*/locations/*/plugins/*/instances/*}
Get an API hub plugin instance.
list GET /v1/{parent=projects/*/locations/*/plugins/*}/instances
List all the plugins in a given project and location.

REST Resource: v1.projects.locations.plugins.styleGuide

Methods
getContents GET /v1/{name=projects/*/locations/*/plugins/*/styleGuide}:contents
Get the contents of the style guide.

REST Resource: v1.projects.locations.runtimeProjectAttachments

Methods
create POST /v1/{parent=projects/*/locations/*}/runtimeProjectAttachments
Attaches a runtime project to the host project.
delete DELETE /v1/{name=projects/*/locations/*/runtimeProjectAttachments/*}
Delete a runtime project attachment in the API hub.
get GET /v1/{name=projects/*/locations/*/runtimeProjectAttachments/*}
Gets a runtime project attachment.
list GET /v1/{parent=projects/*/locations/*}/runtimeProjectAttachments
List runtime projects attached to the host project.