- [Resource: ApiHubInstance](https://docs.cloud.google.com/apigee/docs/reference/apis/apihub/rest/v1/projects.locations.apiHubInstances#ApiHubInstance)
  - [JSON representation](https://docs.cloud.google.com/apigee/docs/reference/apis/apihub/rest/v1/projects.locations.apiHubInstances#ApiHubInstance.SCHEMA_REPRESENTATION)
- [State](https://docs.cloud.google.com/apigee/docs/reference/apis/apihub/rest/v1/projects.locations.apiHubInstances#State)
- [Config](https://docs.cloud.google.com/apigee/docs/reference/apis/apihub/rest/v1/projects.locations.apiHubInstances#Config)
  - [JSON representation](https://docs.cloud.google.com/apigee/docs/reference/apis/apihub/rest/v1/projects.locations.apiHubInstances#Config.SCHEMA_REPRESENTATION)
- [EncryptionType](https://docs.cloud.google.com/apigee/docs/reference/apis/apihub/rest/v1/projects.locations.apiHubInstances#EncryptionType)
- [AgentRegistrySyncConfig](https://docs.cloud.google.com/apigee/docs/reference/apis/apihub/rest/v1/projects.locations.apiHubInstances#AgentRegistrySyncConfig)
  - [JSON representation](https://docs.cloud.google.com/apigee/docs/reference/apis/apihub/rest/v1/projects.locations.apiHubInstances#AgentRegistrySyncConfig.SCHEMA_REPRESENTATION)
- [Methods](https://docs.cloud.google.com/apigee/docs/reference/apis/apihub/rest/v1/projects.locations.apiHubInstances#METHODS_SUMMARY)

## Resource: ApiHubInstance

An ApiHubInstance represents the instance resources of the API Hub. Currently, only one ApiHub instance is allowed for each project.

| JSON representation |
|---|
| ``` { "name": string, "createTime": string, "updateTime": string, "state": enum (`https://docs.cloud.google.com/apigee/docs/reference/apis/apihub/rest/v1/projects.locations.apiHubInstances#State`), "stateMessage": string, "config": { object (`https://docs.cloud.google.com/apigee/docs/reference/apis/apihub/rest/v1/projects.locations.apiHubInstances#Config`) }, "labels": { string: string, ... }, "description": string } ``` |

| Fields ||
|---|---|
| `name` | `string` Identifier. Format: `projects/{project}/locations/{location}/apiHubInstances/{apiHubInstance}`. |
| `createTime` | ``string (`https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` format)`` Output only. Creation timestamp. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: `"2014-10-02T15:01:23Z"`, `"2014-10-02T15:01:23.045123456Z"` or `"2014-10-02T15:01:23+05:30"`. |
| `updateTime` | ``string (`https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` format)`` Output only. Last update timestamp. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: `"2014-10-02T15:01:23Z"`, `"2014-10-02T15:01:23.045123456Z"` or `"2014-10-02T15:01:23+05:30"`. |
| `state` | ``enum (`https://docs.cloud.google.com/apigee/docs/reference/apis/apihub/rest/v1/projects.locations.apiHubInstances#State`)`` Output only. The current state of the ApiHub instance. |
| `stateMessage` | `string` Output only. Extra information about ApiHub instance state. Currently the message would be populated when state is `FAILED`. |
| `config` | ``object (`https://docs.cloud.google.com/apigee/docs/reference/apis/apihub/rest/v1/projects.locations.apiHubInstances#Config`)`` Required. Config of the ApiHub instance. |
| `labels` | `map (key: string, value: string)` Optional. Instance labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. <https://cloud.google.com/compute/docs/labeling-resources> An object containing a list of `"key": value` pairs. Example: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`. |
| `description` | `string` Optional. Description of the ApiHub instance. |

## State

State of the ApiHub Instance.

| Enums ||
|---|---|
| `STATE_UNSPECIFIED` | The default value. This value is used if the state is omitted. |
| `INACTIVE` | The ApiHub instance has not been initialized or has been deleted. |
| `CREATING` | The ApiHub instance is being created. |
| `ACTIVE` | The ApiHub instance has been created and is ready for use. |
| `UPDATING` | The ApiHub instance is being updated. |
| `DELETING` | The ApiHub instance is being deleted. |
| `FAILED` | The ApiHub instance encountered an error during a state change. |

## Config

Available configurations to provision an ApiHub Instance.

| JSON representation |
|---|
| ``` { "cmekKeyName": string, "disableSearch": boolean, "vertexLocation": string, "encryptionType": enum (`https://docs.cloud.google.com/apigee/docs/reference/apis/apihub/rest/v1/projects.locations.apiHubInstances#EncryptionType`), "agentRegistrySyncConfig": { object (`https://docs.cloud.google.com/apigee/docs/reference/apis/apihub/rest/v1/projects.locations.apiHubInstances#AgentRegistrySyncConfig`) } } ``` |

| Fields ||
|---|---|
| `cmekKeyName` | `string` Optional. The Customer Managed Encryption Key (CMEK) used for data encryption. The CMEK name should follow the format of `projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+)`, where the location must match the instance location. If the CMEK is not provided, a GMEK will be created for the instance. |
| `disableSearch` | `boolean` Optional. If true, the search will be disabled for the instance. The default value is false. |
| `vertexLocation` | `string` Optional. The name of the Vertex AI location where the data store is stored. |
| `encryptionType` | ``enum (`https://docs.cloud.google.com/apigee/docs/reference/apis/apihub/rest/v1/projects.locations.apiHubInstances#EncryptionType`)`` Optional. Encryption type for the region. If the encryption type is CMEK, the cmekKeyName must be provided. If no encryption type is provided, GMEK will be used. |
| `agentRegistrySyncConfig` | ``object (`https://docs.cloud.google.com/apigee/docs/reference/apis/apihub/rest/v1/projects.locations.apiHubInstances#AgentRegistrySyncConfig`)`` Optional. The configuration for syncing MCP data in the API Hub instance to the Agent Registry. |

## EncryptionType

Types of data encryption.

| Enums ||
|---|---|
| `ENCRYPTION_TYPE_UNSPECIFIED` | Encryption type unspecified. |
| `GMEK` | Default encryption using Google managed encryption key. |
| `CMEK` | Encryption using customer managed encryption key. |

## AgentRegistrySyncConfig

The configuration for Agent Registry sync.

| JSON representation |
|---|
| ``` { "disabled": boolean } ``` |

| Fields ||
|---|---|
| `disabled` | `boolean` Optional. If true, the MCP data sync to the Agent Registry will be disabled. The default value is false. |

| ## Methods ||
|---|---|
| ### `https://docs.cloud.google.com/apigee/docs/reference/apis/apihub/rest/v1/projects.locations.apiHubInstances/create` | Provisions instance resources for the API Hub. |
| ### `https://docs.cloud.google.com/apigee/docs/reference/apis/apihub/rest/v1/projects.locations.apiHubInstances/delete` | Deletes the API hub instance. |
| ### `https://docs.cloud.google.com/apigee/docs/reference/apis/apihub/rest/v1/projects.locations.apiHubInstances/get` | Gets details of a single API Hub instance. |
| ### `https://docs.cloud.google.com/apigee/docs/reference/apis/apihub/rest/v1/projects.locations.apiHubInstances/lookup` | Looks up an Api Hub instance in a given Google Cloud project. |
| ### `https://docs.cloud.google.com/apigee/docs/reference/apis/apihub/rest/v1/projects.locations.apiHubInstances/patch` | Update an Api Hub instance. |