--- title: "POST /v1/projects/{projectsId}/locations/{locationsId}:searchResources" method: POST path: "/v1/projects/{projectsId}/locations/{locationsId}:searchResources" tags: ["projects"] --- # POST /v1/projects/{projectsId}/locations/{locationsId}:searchResources `POST /v1/projects/{projectsId}/locations/{locationsId}:searchResources` ## Request - Base URL: `https://apihub.googleapis.com` - URL: `https://apihub.googleapis.com/v1/projects/{projectsId}/locations/{locationsId}:searchResources` - Auth: one of: - OAuth 2 and OAuth 2 - Implicit: `https://accounts.google.com/o/oauth2/auth` - Scopes: `https://www.googleapis.com/auth/apihub.readonly` - Authorization code: `https://accounts.google.com/o/oauth2/auth` - Token URL: `https://accounts.google.com/o/oauth2/token` scopes: `https://www.googleapis.com/auth/apihub.readonly` - OAuth 2 and OAuth 2 - Implicit: `https://accounts.google.com/o/oauth2/auth` - Scopes: `https://www.googleapis.com/auth/apihub.readwrite` - Authorization code: `https://accounts.google.com/o/oauth2/auth` - Token URL: `https://accounts.google.com/o/oauth2/token` scopes: `https://www.googleapis.com/auth/apihub.readwrite` - OAuth 2 and OAuth 2 - Implicit: `https://accounts.google.com/o/oauth2/auth` - Scopes: `https://www.googleapis.com/auth/cloud-platform` - Authorization code: `https://accounts.google.com/o/oauth2/auth` - Token URL: `https://accounts.google.com/o/oauth2/token` scopes: `https://www.googleapis.com/auth/cloud-platform` - TypeScript: (a function with typed inputs; its response is checked against the schema) Search across API-Hub resources. ## Path parameters - `projectsId` string, required - `locationsId` string, required ## Request body - GoogleCloudApihubV1SearchResourcesRequest: The SearchResources method's request. - `filter` string: Optional. An expression that filters the list of search results. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string, a number, or a boolean. The comparison operator must be `=`. Filters are not case sensitive. The following field names are eligible for filtering: * `resource_type` - The type of resource in the search results. Must be one of the following: `Api`, `ApiOperation`, `Deployment`, `Definition`, `Spec` or `Version`. This field can only be specified once in the filter. Here are is an example: * `resource_type = Api` - The resource_type is _Api_. - `pageSize` integer: Optional. The maximum number of search results to return. The service may return fewer than this value. If unspecified at most 10 search results will be returned. If value is negative then `INVALID_ARGUMENT` error is returned. The maximum value is 25; values above 25 will be coerced to 25. While paginating, you can specify a new page size parameter for each page of search results to be listed. - `pageToken` string: Optional. A page token, received from a previous SearchResources call. Specify this parameter to retrieve the next page of transactions. When paginating, you must specify the `page_token` parameter and all the other parameters except page_size should be specified with the same value which was used in the previous call. If the other fields are set with a different value than the previous call then `INVALID_ARGUMENT` error is returned. - `query` string: Required. The free text search query. This query can contain keywords which could be related to any detail of the API-Hub resources such display names, descriptions, attributes etc. ## Response `200` Successful response - GoogleCloudApihubV1SearchResourcesResponse: Response for the SearchResources method. - `nextPageToken` string: Pass this token in the SearchResourcesRequest to continue to list results. If all results have been returned, this field is an empty string or not present in the response. - `searchResults` GoogleCloudApihubV1SearchResult[]: List of search results according to the filter and search query specified. The order of search results represents the ranking. - `resource` GoogleCloudApihubV1ApiHubResource: ApiHubResource is one of the resources such as Api, Operation, Deployment, Definition, Spec and Version resources stored in API-Hub. - `api` GoogleCloudApihubV1Api: An API resource in the API Hub. - `apiFunctionalRequirements` GoogleCloudApihubV1AttributeValues: The attribute values associated with resource. - `attribute` string: Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} - `enumValues` GoogleCloudApihubV1EnumAttributeValues: The attribute values of data type enum. - `values` GoogleCloudApihubV1AllowedValue[]: Required. The attribute values in case attribute data type is enum. - … - `jsonValues` GoogleCloudApihubV1StringAttributeValues: The attribute values of data type string or JSON. - `values` string[]: Required. The attribute values in case attribute data type is string or JSON. - `stringValues` GoogleCloudApihubV1StringAttributeValues: The attribute values of data type string or JSON. - `values` string[]: Required. The attribute values in case attribute data type is string or JSON. - `uriValues` GoogleCloudApihubV1StringAttributeValues: The attribute values of data type string or JSON. - `values` string[]: Required. The attribute values in case attribute data type is string or JSON. - `apiRequirements` GoogleCloudApihubV1AttributeValues: The attribute values associated with resource. - `attribute` string: Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} - `enumValues` GoogleCloudApihubV1EnumAttributeValues: The attribute values of data type enum. - `values` GoogleCloudApihubV1AllowedValue[]: Required. The attribute values in case attribute data type is enum. - … - `jsonValues` GoogleCloudApihubV1StringAttributeValues: The attribute values of data type string or JSON. - `values` string[]: Required. The attribute values in case attribute data type is string or JSON. - `stringValues` GoogleCloudApihubV1StringAttributeValues: The attribute values of data type string or JSON. - `values` string[]: Required. The attribute values in case attribute data type is string or JSON. - `uriValues` GoogleCloudApihubV1StringAttributeValues: The attribute values of data type string or JSON. - `values` string[]: Required. The attribute values in case attribute data type is string or JSON. - `apiStyle` GoogleCloudApihubV1AttributeValues: The attribute values associated with resource. - `attribute` string: Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} - `enumValues` GoogleCloudApihubV1EnumAttributeValues: The attribute values of data type enum. - `values` GoogleCloudApihubV1AllowedValue[]: Required. The attribute values in case attribute data type is enum. - … - `jsonValues` GoogleCloudApihubV1StringAttributeValues: The attribute values of data type string or JSON. - `values` string[]: Required. The attribute values in case attribute data type is string or JSON. - `stringValues` GoogleCloudApihubV1StringAttributeValues: The attribute values of data type string or JSON. - `values` string[]: Required. The attribute values in case attribute data type is string or JSON. - `uriValues` GoogleCloudApihubV1StringAttributeValues: The attribute values of data type string or JSON. - `values` string[]: Required. The attribute values in case attribute data type is string or JSON. - `apiTechnicalRequirements` GoogleCloudApihubV1AttributeValues: The attribute values associated with resource. - `attribute` string: Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} - `enumValues` GoogleCloudApihubV1EnumAttributeValues: The attribute values of data type enum. - `values` GoogleCloudApihubV1AllowedValue[]: Required. The attribute values in case attribute data type is enum. - … - `jsonValues` GoogleCloudApihubV1StringAttributeValues: The attribute values of data type string or JSON. - `values` string[]: Required. The attribute values in case attribute data type is string or JSON. - `stringValues` GoogleCloudApihubV1StringAttributeValues: The attribute values of data type string or JSON. - `values` string[]: Required. The attribute values in case attribute data type is string or JSON. - `uriValues` GoogleCloudApihubV1StringAttributeValues: The attribute values of data type string or JSON. - `values` string[]: Required. The attribute values in case attribute data type is string or JSON. - `attributes` object: Optional. The list of user defined attributes associated with the API 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. - `businessUnit` GoogleCloudApihubV1AttributeValues: The attribute values associated with resource. - `attribute` string: Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} - `enumValues` GoogleCloudApihubV1EnumAttributeValues: The attribute values of data type enum. - `values` GoogleCloudApihubV1AllowedValue[]: Required. The attribute values in case attribute data type is enum. - … - `jsonValues` GoogleCloudApihubV1StringAttributeValues: The attribute values of data type string or JSON. - `values` string[]: Required. The attribute values in case attribute data type is string or JSON. - `stringValues` GoogleCloudApihubV1StringAttributeValues: The attribute values of data type string or JSON. - `values` string[]: Required. The attribute values in case attribute data type is string or JSON. - `uriValues` GoogleCloudApihubV1StringAttributeValues: The attribute values of data type string or JSON. - `values` string[]: Required. The attribute values in case attribute data type is string or JSON. - `createTime` string, google-datetime: Output only. The time at which the API resource was created. - `description` string: Optional. The description of the API resource. - `displayName` string: Required. The display name of the API resource. - `documentation` GoogleCloudApihubV1Documentation: Documentation details. - `externalUri` string: Optional. The uri of the externally hosted documentation. - `fingerprint` string: Optional. Fingerprint of the API resource. This must be unique for each API resource. It can neither be unset nor be updated to an existing fingerprint of another API resource. - `maturityLevel` GoogleCloudApihubV1AttributeValues: The attribute values associated with resource. - `attribute` string: Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} - `enumValues` GoogleCloudApihubV1EnumAttributeValues: The attribute values of data type enum. - `values` GoogleCloudApihubV1AllowedValue[]: Required. The attribute values in case attribute data type is enum. - … - `jsonValues` GoogleCloudApihubV1StringAttributeValues: The attribute values of data type string or JSON. - `values` string[]: Required. The attribute values in case attribute data type is string or JSON. - `stringValues` GoogleCloudApihubV1StringAttributeValues: The attribute values of data type string or JSON. - `values` string[]: Required. The attribute values in case attribute data type is string or JSON. - `uriValues` GoogleCloudApihubV1StringAttributeValues: The attribute values of data type string or JSON. - `values` string[]: Required. The attribute values in case attribute data type is string or JSON. - `name` string: Identifier. The name of the API resource in the API Hub. Format: `projects/{project}/locations/{location}/apis/{api}` - `owner` GoogleCloudApihubV1Owner: Owner details. - `displayName` string: Optional. The name of the owner. - `email` string: Required. The email of the owner. - `selectedVersion` string: Optional. The selected version for an API resource. This can be used when special handling is needed on client side for particular version of the API. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}` - `serviceType` GoogleCloudApihubV1AttributeValues: The attribute values associated with resource. - `attribute` string: Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} - `enumValues` GoogleCloudApihubV1EnumAttributeValues: The attribute values of data type enum. - `values` GoogleCloudApihubV1AllowedValue[]: Required. The attribute values in case attribute data type is enum. - … - `jsonValues` GoogleCloudApihubV1StringAttributeValues: The attribute values of data type string or JSON. - `values` string[]: Required. The attribute values in case attribute data type is string or JSON. - `stringValues` GoogleCloudApihubV1StringAttributeValues: The attribute values of data type string or JSON. - `values` string[]: Required. The attribute values in case attribute data type is string or JSON. - `uriValues` GoogleCloudApihubV1StringAttributeValues: The attribute values of data type string or JSON. - `values` string[]: Required. The attribute values in case attribute data type is string or JSON. - `sourceMetadata` GoogleCloudApihubV1SourceMetadata[]: Output only. The list of sources and metadata from the sources of the API resource. - `originalResourceCreateTime` string, google-datetime: Output only. The time at which the resource was created at the source. - `originalResourceId` string: Output only. The unique identifier of the resource at the source. - `originalResourceUpdateTime` string, google-datetime: Output only. The time at which the resource was last updated at the source. - `pluginInstanceActionSource` GoogleCloudApihubV1PluginInstanceActionSource: PluginInstanceActionSource represents the plugin instance action source. - `actionId` string: Output only. The id of the plugin instance action. - `pluginInstance` string: Output only. The resource name of the source plugin instance. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}` - `sourceType` 'SOURCE_TYPE_UNSPECIFIED' | 'PLUGIN': Output only. The type of the source. - `targetUser` GoogleCloudApihubV1AttributeValues: The attribute values associated with resource. - `attribute` string: Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} - `enumValues` GoogleCloudApihubV1EnumAttributeValues: The attribute values of data type enum. - `values` GoogleCloudApihubV1AllowedValue[]: Required. The attribute values in case attribute data type is enum. - … - `jsonValues` GoogleCloudApihubV1StringAttributeValues: The attribute values of data type string or JSON. - `values` string[]: Required. The attribute values in case attribute data type is string or JSON. - `stringValues` GoogleCloudApihubV1StringAttributeValues: The attribute values of data type string or JSON. - `values` string[]: Required. The attribute values in case attribute data type is string or JSON. - `uriValues` GoogleCloudApihubV1StringAttributeValues: The attribute values of data type string or JSON. - `values` string[]: Required. The attribute values in case attribute data type is string or JSON. - `team` GoogleCloudApihubV1AttributeValues: The attribute values associated with resource. - `attribute` string: Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} - `enumValues` GoogleCloudApihubV1EnumAttributeValues: The attribute values of data type enum. - `values` GoogleCloudApihubV1AllowedValue[]: Required. The attribute values in case attribute data type is enum. - … - `jsonValues` GoogleCloudApihubV1StringAttributeValues: The attribute values of data type string or JSON. - `values` string[]: Required. The attribute values in case attribute data type is string or JSON. - `stringValues` GoogleCloudApihubV1StringAttributeValues: The attribute values of data type string or JSON. - `values` string[]: Required. The attribute values in case attribute data type is string or JSON. - `uriValues` GoogleCloudApihubV1StringAttributeValues: The attribute values of data type string or JSON. - `values` string[]: Required. The attribute values in case attribute data type is string or JSON. - `updateTime` string, google-datetime: Output only. The time at which the API resource was last updated. - `versions` string[]: Output only. The list of versions present in an API resource. Note: An API resource can be associated with more than 1 version. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}` - `definition` GoogleCloudApihubV1Definition: Represents a definition for example schema, request, response definitions contained in an API version. A definition is added/updated/deleted in an API version when a new spec is added or an existing spec is updated/deleted in a version. Currently, definition will be created only corresponding to OpenAPI spec as parsing is supported for OpenAPI spec. Also, within OpenAPI spec, only `schema` object is supported. - `attributes` object: Optional. The list of user defined attributes associated with the definition 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. - `createTime` string, google-datetime: Output only. The time at which the definition was created. - `name` string: Identifier. The name of the definition. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/definitions/{definition}` - `schema` GoogleCloudApihubV1Schema: The schema details derived from the spec. Currently, this entity is supported for OpenAPI spec only. For OpenAPI spec, this maps to the schema defined in the `definitions` section for OpenAPI 2.0 version and in `components.schemas` section for OpenAPI 3.0 and 3.1 version. - `displayName` string: Output only. The display name of the schema. This will map to the name of the schema in the spec. - `rawValue` string, byte: Output only. The raw value of the schema definition corresponding to the schema name in the spec. - `spec` string: Output only. The name of the spec from where the definition was parsed. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}` - `type` 'TYPE_UNSPECIFIED' | 'SCHEMA': Output only. The type of the definition. - `updateTime` string, google-datetime: Output only. The time at which the definition was last updated. - `deployment` GoogleCloudApihubV1Deployment: Details of the deployment where APIs are hosted. A deployment could represent an Apigee proxy, API gateway, other Google Cloud services or non-Google Cloud services as well. A deployment entity is a root level entity in the API hub and exists independent of any API. - `apiOperations` string[]: Output only. The API operations linked directly to this deployment. - `apiVersions` string[]: Output only. The API versions linked to this deployment. Note: A particular deployment could be linked to multiple different API versions (of same or different APIs). - `attributes` object: Optional. The list of user defined attributes associated with the deployment 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. - `createTime` string, google-datetime: Output only. The time at which the deployment was created. - `deploymentType` GoogleCloudApihubV1AttributeValues: The attribute values associated with resource. - `attribute` string: Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} - `enumValues` GoogleCloudApihubV1EnumAttributeValues: The attribute values of data type enum. - `values` GoogleCloudApihubV1AllowedValue[]: Required. The attribute values in case attribute data type is enum. - … - `jsonValues` GoogleCloudApihubV1StringAttributeValues: The attribute values of data type string or JSON. - `values` string[]: Required. The attribute values in case attribute data type is string or JSON. - `stringValues` GoogleCloudApihubV1StringAttributeValues: The attribute values of data type string or JSON. - `values` string[]: Required. The attribute values in case attribute data type is string or JSON. - `uriValues` GoogleCloudApihubV1StringAttributeValues: The attribute values of data type string or JSON. - `values` string[]: Required. The attribute values in case attribute data type is string or JSON. - `description` string: Optional. The description of the deployment. - `displayName` string: Required. The display name of the deployment. - `documentation` GoogleCloudApihubV1Documentation: Documentation details. - `externalUri` string: Optional. The uri of the externally hosted documentation. - `endpoints` string[]: Required. The endpoints at which this deployment resource is listening for API requests. This could be a list of complete URIs, hostnames or an IP addresses. - `environment` GoogleCloudApihubV1AttributeValues: The attribute values associated with resource. - `attribute` string: Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} - `enumValues` GoogleCloudApihubV1EnumAttributeValues: The attribute values of data type enum. - `values` GoogleCloudApihubV1AllowedValue[]: Required. The attribute values in case attribute data type is enum. - … - `jsonValues` GoogleCloudApihubV1StringAttributeValues: The attribute values of data type string or JSON. - `values` string[]: Required. The attribute values in case attribute data type is string or JSON. - `stringValues` GoogleCloudApihubV1StringAttributeValues: The attribute values of data type string or JSON. - `values` string[]: Required. The attribute values in case attribute data type is string or JSON. - `uriValues` GoogleCloudApihubV1StringAttributeValues: The attribute values of data type string or JSON. - `values` string[]: Required. The attribute values in case attribute data type is string or JSON. - `managementUrl` GoogleCloudApihubV1AttributeValues: The attribute values associated with resource. - `attribute` string: Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} - `enumValues` GoogleCloudApihubV1EnumAttributeValues: The attribute values of data type enum. - `values` GoogleCloudApihubV1AllowedValue[]: Required. The attribute values in case attribute data type is enum. - … - `jsonValues` GoogleCloudApihubV1StringAttributeValues: The attribute values of data type string or JSON. - `values` string[]: Required. The attribute values in case attribute data type is string or JSON. - `stringValues` GoogleCloudApihubV1StringAttributeValues: The attribute values of data type string or JSON. - `values` string[]: Required. The attribute values in case attribute data type is string or JSON. - `uriValues` GoogleCloudApihubV1StringAttributeValues: The attribute values of data type string or JSON. - `values` string[]: Required. The attribute values in case attribute data type is string or JSON. - `name` string: Identifier. The name of the deployment. Format: `projects/{project}/locations/{location}/deployments/{deployment}` - `resourceUri` string: Required. The resource URI identifies the deployment within its gateway. For Apigee gateways, its recommended to use the format: organizations/{org}/environments/{env}/apis/{api}. For ex: if a proxy with name `orders` is deployed in `staging` environment of `cymbal` organization, the resource URI would be: `organizations/cymbal/environments/staging/apis/orders`. - `slo` GoogleCloudApihubV1AttributeValues: The attribute values associated with resource. - `attribute` string: Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} - `enumValues` GoogleCloudApihubV1EnumAttributeValues: The attribute values of data type enum. - `values` GoogleCloudApihubV1AllowedValue[]: Required. The attribute values in case attribute data type is enum. - … - `jsonValues` GoogleCloudApihubV1StringAttributeValues: The attribute values of data type string or JSON. - `values` string[]: Required. The attribute values in case attribute data type is string or JSON. - `stringValues` GoogleCloudApihubV1StringAttributeValues: The attribute values of data type string or JSON. - `values` string[]: Required. The attribute values in case attribute data type is string or JSON. - `uriValues` GoogleCloudApihubV1StringAttributeValues: The attribute values of data type string or JSON. - `values` string[]: Required. The attribute values in case attribute data type is string or JSON. - `sourceEnvironment` string: Optional. The environment at source for the deployment. For example: prod, dev, staging, etc. - `sourceMetadata` GoogleCloudApihubV1SourceMetadata[]: Output only. The list of sources and metadata from the sources of the deployment. - `originalResourceCreateTime` string, google-datetime: Output only. The time at which the resource was created at the source. - `originalResourceId` string: Output only. The unique identifier of the resource at the source. - `originalResourceUpdateTime` string, google-datetime: Output only. The time at which the resource was last updated at the source. - `pluginInstanceActionSource` GoogleCloudApihubV1PluginInstanceActionSource: PluginInstanceActionSource represents the plugin instance action source. - `actionId` string: Output only. The id of the plugin instance action. - `pluginInstance` string: Output only. The resource name of the source plugin instance. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}` - `sourceType` 'SOURCE_TYPE_UNSPECIFIED' | 'PLUGIN': Output only. The type of the source. - `sourceProject` string: Optional. The project to which the deployment belongs. For Google Cloud gateways, this will refer to the project identifier. For others like Edge/OPDK, this will refer to the org identifier. - `sourceRevision` string: Optional. A revision identifier for the underlying gateway configuration that this deployment serves. For Apigee gateway variants, this is typically the proxy revision number populated automatically when the deployment is discovered. - `sourceUri` GoogleCloudApihubV1AttributeValues: The attribute values associated with resource. - `attribute` string: Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} - `enumValues` GoogleCloudApihubV1EnumAttributeValues: The attribute values of data type enum. - `values` GoogleCloudApihubV1AllowedValue[]: Required. The attribute values in case attribute data type is enum. - … - `jsonValues` GoogleCloudApihubV1StringAttributeValues: The attribute values of data type string or JSON. - `values` string[]: Required. The attribute values in case attribute data type is string or JSON. - `stringValues` GoogleCloudApihubV1StringAttributeValues: The attribute values of data type string or JSON. - `values` string[]: Required. The attribute values in case attribute data type is string or JSON. - `uriValues` GoogleCloudApihubV1StringAttributeValues: The attribute values of data type string or JSON. - `values` string[]: Required. The attribute values in case attribute data type is string or JSON. - `specs` string[]: Output only. The specs linked directly to this deployment. Note: a deployment could serve multiple specs (e.g., across different revisions of the same underlying gateway configuration). - `updateTime` string, google-datetime: Output only. The time at which the deployment was last updated. - `operation` GoogleCloudApihubV1ApiOperation: Represents an operation contained in an API version in the API Hub. An operation is added/updated/deleted in an API version when a new spec is added or an existing spec is updated/deleted in a version. Currently, an operation will be created only corresponding to OpenAPI spec as parsing is supported for OpenAPI spec. Alternatively operations can be managed via create,update and delete APIs, creation of apiOperation can be possible only for version with no parsed operations and update/delete can be possible only for operations created via create API. - `attributes` object: Optional. The list of user defined attributes associated with the API operation 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. - `createTime` string, google-datetime: Output only. The time at which the operation was created. - `deployments` string[]: Optional. The deployments linked directly to this API operation. For operations parsed from a spec, `UpdateApiOperation` returns `FAILED_PRECONDITION`; link the parent spec to the deployment via `Spec.deployments` instead. Format is `projects/{project}/locations/{location}/deployments/{deployment}` - `details` GoogleCloudApihubV1OperationDetails: The operation details parsed from the spec. - `deprecated` boolean: Optional. For OpenAPI spec, this will be set if `operation.deprecated`is marked as `true` in the spec. - `description` string: Optional. Description of the operation behavior. For OpenAPI spec, this will map to `operation.description` in the spec, in case description is empty, `operation.summary` will be used. - `documentation` GoogleCloudApihubV1Documentation: Documentation details. - `externalUri` string: Optional. The uri of the externally hosted documentation. - `httpOperation` GoogleCloudApihubV1HttpOperation: The HTTP Operation. - `method` 'METHOD_UNSPECIFIED' | 'GET' | 'PUT' | 'POST' | 'DELETE' | 'OPTIONS' | 'HEAD' | 'PATCH' | 'TRACE': Optional. Operation method Note: Even though this field is optional, it is required for CreateApiOperation API and we will fail the request if not provided. - `path` GoogleCloudApihubV1Path: The path details derived from the spec. - … - `mcpTool` GoogleCloudApihubV1McpTool: Details describing an MCP Tool. - `annotations` GoogleCloudApihubV1ToolAnnotations: Annotations for a Tool. - … - `description` string: Optional. Description of what the tool does. - `inputSchema` GoogleCloudApihubV1OperationSchema: The operation schema needed for an operation. - … - `name` string: Required. The name of the tool, unique within its parent scope (version). - `outputSchema` GoogleCloudApihubV1OperationSchema: The operation schema needed for an operation. - … - `title` string: Optional. Optional title for the tool. - `name` string: Identifier. The name of the operation. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}` - `sourceMetadata` GoogleCloudApihubV1SourceMetadata[]: Output only. The list of sources and metadata from the sources of the API operation. - `originalResourceCreateTime` string, google-datetime: Output only. The time at which the resource was created at the source. - `originalResourceId` string: Output only. The unique identifier of the resource at the source. - `originalResourceUpdateTime` string, google-datetime: Output only. The time at which the resource was last updated at the source. - `pluginInstanceActionSource` GoogleCloudApihubV1PluginInstanceActionSource: PluginInstanceActionSource represents the plugin instance action source. - `actionId` string: Output only. The id of the plugin instance action. - `pluginInstance` string: Output only. The resource name of the source plugin instance. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}` - `sourceType` 'SOURCE_TYPE_UNSPECIFIED' | 'PLUGIN': Output only. The type of the source. - `spec` string: Output only. The name of the spec will be of the format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}` Note:The name of the spec will be empty if the operation is created via CreateApiOperation API. - `updateTime` string, google-datetime: Output only. The time at which the operation was last updated. - `spec` GoogleCloudApihubV1Spec: Represents a spec associated with an API version in the API Hub. Note that specs of various types can be uploaded, however parsing of details is supported for OpenAPI spec currently. - `additionalSpecContents` GoogleCloudApihubV1AdditionalSpecContent[]: Output only. The additional spec contents for the spec. - `createTime` string, google-datetime: Output only. The time at which the spec content was created. - `labels` object: Optional. The labels of the spec content e.g. specboost addon version. - `specContentType` 'SPEC_CONTENT_TYPE_UNSPECIFIED' | 'BOOSTED_SPEC_CONTENT' | 'GATEWAY_OPEN_API_SPEC': Required. The type of the spec content. - `specContents` GoogleCloudApihubV1SpecContents: The spec contents. - `contents` string, byte: Required. The contents of the spec. The contents should be base64 encoded while calling the OnePlatform APIs like CreateSpec, UpdateSpec and CollectApiData. - `mimeType` string: Required. The mime type of the content for example application/json, application/yaml, application/wsdl etc. - `updateTime` string, google-datetime: Output only. The time at which the spec content was last updated. - `attributes` object: Optional. The list of user defined attributes associated with the spec. 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. - `contents` GoogleCloudApihubV1SpecContents: The spec contents. - `contents` string, byte: Required. The contents of the spec. The contents should be base64 encoded while calling the OnePlatform APIs like CreateSpec, UpdateSpec and CollectApiData. - `mimeType` string: Required. The mime type of the content for example application/json, application/yaml, application/wsdl etc. - `createTime` string, google-datetime: Output only. The time at which the spec was created. - `deployments` string[]: Optional. The deployments linked directly to this spec. Format is `projects/{project}/locations/{location}/deployments/{deployment}` - `details` GoogleCloudApihubV1SpecDetails: SpecDetails contains the details parsed from supported spec types. - `description` string: Output only. The description of the spec. - `openApiSpecDetails` GoogleCloudApihubV1OpenApiSpecDetails: OpenApiSpecDetails contains the details parsed from an OpenAPI spec in addition to the fields mentioned in SpecDetails. - `format` 'FORMAT_UNSPECIFIED' | 'OPEN_API_SPEC_2_0' | 'OPEN_API_SPEC_3_0' | 'OPEN_API_SPEC_3_1': Output only. The format of the spec. - `owner` GoogleCloudApihubV1Owner: Owner details. - … - `version` string: Output only. The version in the spec. This maps to `info.version` in OpenAPI spec. - `displayName` string: Required. The display name of the spec. This can contain the file name of the spec. - `documentation` GoogleCloudApihubV1Documentation: Documentation details. - `externalUri` string: Optional. The uri of the externally hosted documentation. - `lintResponse` GoogleCloudApihubV1LintResponse: LintResponse contains the response from the linter. - `createTime` string, google-datetime: Required. Timestamp when the linting response was generated. - `issues` GoogleCloudApihubV1Issue[]: Optional. Array of issues found in the analyzed document. - `code` string: Required. Rule code unique to each rule defined in linter. - `message` string: Required. Human-readable message describing the issue found by the linter. - `path` string[]: Required. An array of strings indicating the location in the analyzed document where the rule was triggered. - `range` GoogleCloudApihubV1Range: Object describing where in the file the issue was found. - … - `severity` 'SEVERITY_UNSPECIFIED' | 'SEVERITY_ERROR' | 'SEVERITY_WARNING' | 'SEVERITY_INFO' | 'SEVERITY_HINT': Required. Severity level of the rule violation. - `linter` 'LINTER_UNSPECIFIED' | 'SPECTRAL' | 'OTHER': Required. Name of the linter used. - `source` string: Required. Name of the linting application. - `state` 'LINT_STATE_UNSPECIFIED' | 'LINT_STATE_SUCCESS' | 'LINT_STATE_ERROR': Required. Lint state represents success or failure for linting. - `summary` GoogleCloudApihubV1SummaryEntry[]: Optional. Summary of all issue types and counts for each severity level. - `count` integer: Required. Count of issues with the given severity. - `severity` 'SEVERITY_UNSPECIFIED' | 'SEVERITY_ERROR' | 'SEVERITY_WARNING' | 'SEVERITY_INFO' | 'SEVERITY_HINT': Required. Severity of the issue. - `name` string: Identifier. The name of the spec. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}` - `parsingMode` 'PARSING_MODE_UNSPECIFIED' | 'RELAXED' | 'STRICT': Optional. Input only. Enum specifying the parsing mode for OpenAPI Specification (OAS) parsing. - `sourceMetadata` GoogleCloudApihubV1SourceMetadata[]: Output only. The list of sources and metadata from the sources of the spec. - `originalResourceCreateTime` string, google-datetime: Output only. The time at which the resource was created at the source. - `originalResourceId` string: Output only. The unique identifier of the resource at the source. - `originalResourceUpdateTime` string, google-datetime: Output only. The time at which the resource was last updated at the source. - `pluginInstanceActionSource` GoogleCloudApihubV1PluginInstanceActionSource: PluginInstanceActionSource represents the plugin instance action source. - `actionId` string: Output only. The id of the plugin instance action. - `pluginInstance` string: Output only. The resource name of the source plugin instance. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}` - `sourceType` 'SOURCE_TYPE_UNSPECIFIED' | 'PLUGIN': Output only. The type of the source. - `sourceUri` string: Optional. The URI of the spec source in case file is uploaded from an external version control system. - `specType` GoogleCloudApihubV1AttributeValues: The attribute values associated with resource. - `attribute` string: Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} - `enumValues` GoogleCloudApihubV1EnumAttributeValues: The attribute values of data type enum. - `values` GoogleCloudApihubV1AllowedValue[]: Required. The attribute values in case attribute data type is enum. - … - `jsonValues` GoogleCloudApihubV1StringAttributeValues: The attribute values of data type string or JSON. - `values` string[]: Required. The attribute values in case attribute data type is string or JSON. - `stringValues` GoogleCloudApihubV1StringAttributeValues: The attribute values of data type string or JSON. - `values` string[]: Required. The attribute values in case attribute data type is string or JSON. - `uriValues` GoogleCloudApihubV1StringAttributeValues: The attribute values of data type string or JSON. - `values` string[]: Required. The attribute values in case attribute data type is string or JSON. - `updateTime` string, google-datetime: Output only. The time at which the spec was last updated. - `version` GoogleCloudApihubV1Version: Represents a version of the API resource in API hub. This is also referred to as the API version. - `accreditation` GoogleCloudApihubV1AttributeValues: The attribute values associated with resource. - `attribute` string: Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} - `enumValues` GoogleCloudApihubV1EnumAttributeValues: The attribute values of data type enum. - `values` GoogleCloudApihubV1AllowedValue[]: Required. The attribute values in case attribute data type is enum. - … - `jsonValues` GoogleCloudApihubV1StringAttributeValues: The attribute values of data type string or JSON. - `values` string[]: Required. The attribute values in case attribute data type is string or JSON. - `stringValues` GoogleCloudApihubV1StringAttributeValues: The attribute values of data type string or JSON. - `values` string[]: Required. The attribute values in case attribute data type is string or JSON. - `uriValues` GoogleCloudApihubV1StringAttributeValues: The attribute values of data type string or JSON. - `values` string[]: Required. The attribute values in case attribute data type is string or JSON. - `apiOperations` string[]: Output only. The operations contained in the API version. These operations will be added to the version when a new spec is added or when an existing spec is updated. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}` - `attributes` object: 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. - `compliance` GoogleCloudApihubV1AttributeValues: The attribute values associated with resource. - `attribute` string: Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} - `enumValues` GoogleCloudApihubV1EnumAttributeValues: The attribute values of data type enum. - `values` GoogleCloudApihubV1AllowedValue[]: Required. The attribute values in case attribute data type is enum. - … - `jsonValues` GoogleCloudApihubV1StringAttributeValues: The attribute values of data type string or JSON. - `values` string[]: Required. The attribute values in case attribute data type is string or JSON. - `stringValues` GoogleCloudApihubV1StringAttributeValues: The attribute values of data type string or JSON. - `values` string[]: Required. The attribute values in case attribute data type is string or JSON. - `uriValues` GoogleCloudApihubV1StringAttributeValues: The attribute values of data type string or JSON. - `values` string[]: Required. The attribute values in case attribute data type is string or JSON. - `createTime` string, google-datetime: Output only. The time at which the version was created. - `definitions` string[]: Output only. The definitions contained in the API version. These definitions will be added to the version when a new spec is added or when an existing spec is updated. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}/definitions/{definition}` - `deployments` string[]: Optional. The deployments linked directly to this API version. Only directly-linked deployments are returned; deployments linked to this version's specs or operations are not included. Note: A particular API version could be deployed to multiple deployments (for dev deployment, UAT deployment, etc) Format is `projects/{project}/locations/{location}/deployments/{deployment}` - `description` string: Optional. The description of the version. - `displayName` string: Required. The display name of the version. - `documentation` GoogleCloudApihubV1Documentation: Documentation details. - `externalUri` string: Optional. The uri of the externally hosted documentation. - `lifecycle` GoogleCloudApihubV1AttributeValues: The attribute values associated with resource. - `attribute` string: Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} - `enumValues` GoogleCloudApihubV1EnumAttributeValues: The attribute values of data type enum. - `values` GoogleCloudApihubV1AllowedValue[]: Required. The attribute values in case attribute data type is enum. - … - `jsonValues` GoogleCloudApihubV1StringAttributeValues: The attribute values of data type string or JSON. - `values` string[]: Required. The attribute values in case attribute data type is string or JSON. - `stringValues` GoogleCloudApihubV1StringAttributeValues: The attribute values of data type string or JSON. - `values` string[]: Required. The attribute values in case attribute data type is string or JSON. - `uriValues` GoogleCloudApihubV1StringAttributeValues: The attribute values of data type string or JSON. - `values` string[]: Required. The attribute values in case attribute data type is string or JSON. - `name` string: Identifier. The name of the version. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}` - `selectedDeployment` string: Optional. The selected deployment for a Version resource. This can be used when special handling is needed on client side for a particular deployment linked to the version. Format is `projects/{project}/locations/{location}/deployments/{deployment}` - `sourceMetadata` GoogleCloudApihubV1SourceMetadata[]: Output only. The list of sources and metadata from the sources of the version. - `originalResourceCreateTime` string, google-datetime: Output only. The time at which the resource was created at the source. - `originalResourceId` string: Output only. The unique identifier of the resource at the source. - `originalResourceUpdateTime` string, google-datetime: Output only. The time at which the resource was last updated at the source. - `pluginInstanceActionSource` GoogleCloudApihubV1PluginInstanceActionSource: PluginInstanceActionSource represents the plugin instance action source. - `actionId` string: Output only. The id of the plugin instance action. - `pluginInstance` string: Output only. The resource name of the source plugin instance. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}` - `sourceType` 'SOURCE_TYPE_UNSPECIFIED' | 'PLUGIN': Output only. The type of the source. - `specs` string[]: Output only. The specs associated with this version. Note that an API version can be associated with multiple specs. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}` - `updateTime` string, google-datetime: Output only. The time at which the version was last updated. ## Changes - **2026-11-08** `09b6c7d2247b`: 4 info - the security scope `https://www.googleapis.com/auth/apihub.readonly` was added to the endpoint's security scheme `Oauth2` - the security scope `https://www.googleapis.com/auth/apihub.readonly` was added to the endpoint's security scheme `Oauth2c` - the security scope `https://www.googleapis.com/auth/cloud-platform` was removed from the endpoint's security scheme `Oauth2` - the security scope `https://www.googleapis.com/auth/cloud-platform` was removed from the endpoint's security scheme `Oauth2c` [Operation history](https://skmtc.dev/google/apis/apihub/changes/v1/projects/:projectsId/locations/:locationsId:searchResources/post.md) --- [API](https://skmtc.dev/google/apis/apihub.md) - [All operations](https://skmtc.dev/google/apis/apihub/llms.txt) - [OpenAPI document](https://skmtc.dev/google/apis/apihub/revisions/09b6c7d2247b?raw)