- [Resource: Instance](https://docs.cloud.google.com/secure-source-manager/docs/reference/rest/v1/projects.locations.instances#Instance)
  - [JSON representation](https://docs.cloud.google.com/secure-source-manager/docs/reference/rest/v1/projects.locations.instances#Instance.SCHEMA_REPRESENTATION)
- [PrivateConfig](https://docs.cloud.google.com/secure-source-manager/docs/reference/rest/v1/projects.locations.instances#PrivateConfig)
  - [JSON representation](https://docs.cloud.google.com/secure-source-manager/docs/reference/rest/v1/projects.locations.instances#PrivateConfig.SCHEMA_REPRESENTATION)
- [CustomHostConfig](https://docs.cloud.google.com/secure-source-manager/docs/reference/rest/v1/projects.locations.instances#CustomHostConfig)
  - [JSON representation](https://docs.cloud.google.com/secure-source-manager/docs/reference/rest/v1/projects.locations.instances#CustomHostConfig.SCHEMA_REPRESENTATION)
- [State](https://docs.cloud.google.com/secure-source-manager/docs/reference/rest/v1/projects.locations.instances#State)
- [StateNote](https://docs.cloud.google.com/secure-source-manager/docs/reference/rest/v1/projects.locations.instances#StateNote)
- [HostConfig](https://docs.cloud.google.com/secure-source-manager/docs/reference/rest/v1/projects.locations.instances#HostConfig)
  - [JSON representation](https://docs.cloud.google.com/secure-source-manager/docs/reference/rest/v1/projects.locations.instances#HostConfig.SCHEMA_REPRESENTATION)
- [WorkforceIdentityFederationConfig](https://docs.cloud.google.com/secure-source-manager/docs/reference/rest/v1/projects.locations.instances#WorkforceIdentityFederationConfig)
  - [JSON representation](https://docs.cloud.google.com/secure-source-manager/docs/reference/rest/v1/projects.locations.instances#WorkforceIdentityFederationConfig.SCHEMA_REPRESENTATION)
- [Methods](https://docs.cloud.google.com/secure-source-manager/docs/reference/rest/v1/projects.locations.instances#METHODS_SUMMARY)

## Resource: Instance

A resource that represents a Secure Source Manager instance.

| JSON representation |
|---|
| ``` { "name": string, "createTime": string, "updateTime": string, "labels": { string: string, ... }, "privateConfig": { object (`https://docs.cloud.google.com/secure-source-manager/docs/reference/rest/v1/projects.locations.instances#PrivateConfig`) }, "state": enum (`https://docs.cloud.google.com/secure-source-manager/docs/reference/rest/v1/projects.locations.instances#State`), "stateNote": enum (`https://docs.cloud.google.com/secure-source-manager/docs/reference/rest/v1/projects.locations.instances#StateNote`), "kmsKey": string, "hostConfig": { object (`https://docs.cloud.google.com/secure-source-manager/docs/reference/rest/v1/projects.locations.instances#HostConfig`) }, "workforceIdentityFederationConfig": { object (`https://docs.cloud.google.com/secure-source-manager/docs/reference/rest/v1/projects.locations.instances#WorkforceIdentityFederationConfig`) }, "satisfiesPzi": boolean, "satisfiesPzs": boolean } ``` |

| Fields ||
|---|---|
| `name` | `string` Identifier. A unique identifier for an instance. The name should be of the format: `projects/{project_number}/locations/{locationId}/instances/{instanceId}` `project_number`: Maps to a unique int64 id assigned to each project. `locationId`: Refers to the region where the instance will be deployed. Since Secure Source Manager is a regional service, it must be one of the valid GCP regions. `instanceId`: User provided name for the instance, must be unique for a project_number and locationId combination. |
| `createTime` | ``string (`https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` format)`` Output only. Create 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. 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"`. |
| `labels` | `map (key: string, value: string)` Optional. Labels as key value pairs. Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. For more information, see [Requirements for labels](https://cloud.google.com/resource-manager/docs/best-practices-labels#label_encoding). An object containing a list of `"key": value` pairs. Example: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`. |
| `privateConfig` | ``object (`https://docs.cloud.google.com/secure-source-manager/docs/reference/rest/v1/projects.locations.instances#PrivateConfig`)`` Optional. Private settings for private instance. |
| `state` | ``enum (`https://docs.cloud.google.com/secure-source-manager/docs/reference/rest/v1/projects.locations.instances#State`)`` Output only. Current state of the instance. |
| `stateNote` | ``enum (`https://docs.cloud.google.com/secure-source-manager/docs/reference/rest/v1/projects.locations.instances#StateNote`)`` Output only. An optional field providing information about the current instance state. |
| `kmsKey` | `string` Optional. Immutable. Customer-managed encryption key name, in the format projects/\*/locations/\*/keyRings/\*/cryptoKeys/\*. |
| `hostConfig` | ``object (`https://docs.cloud.google.com/secure-source-manager/docs/reference/rest/v1/projects.locations.instances#HostConfig`)`` Output only. A list of hostnames for this instance. |
| `workforceIdentityFederationConfig` | ``object (`https://docs.cloud.google.com/secure-source-manager/docs/reference/rest/v1/projects.locations.instances#WorkforceIdentityFederationConfig`)`` Optional. Configuration for Workforce Identity Federation to support third party identity provider. If unset, defaults to the Google OIDC IdP. |
| `satisfiesPzi` | `boolean` Output only. Reserved for future use. |
| `satisfiesPzs` | `boolean` Output only. Reserved for future use. |

## PrivateConfig

PrivateConfig includes settings for private instance.

| JSON representation |
|---|
| ``` { "isPrivate": boolean, "caPool": string, "httpServiceAttachment": string, "sshServiceAttachment": string, "pscAllowedProjects": [ string ], "customHostConfig": { object (`https://docs.cloud.google.com/secure-source-manager/docs/reference/rest/v1/projects.locations.instances#CustomHostConfig`) } } ``` |

| Fields ||
|---|---|
| `isPrivate` | `boolean` Required. Immutable. Indicate if it's private instance. |
| `caPool` | `string` Optional. Immutable. CA pool resource, resource must in the format of `projects/{project}/locations/{location}/caPools/{caPool}`. |
| `httpServiceAttachment` | `string` Output only. Service Attachment for HTTP, resource is in the format of `projects/{project}/regions/{region}/serviceAttachments/{service_attachment}`. |
| `sshServiceAttachment` | `string` Output only. Service Attachment for SSH, resource is in the format of `projects/{project}/regions/{region}/serviceAttachments/{service_attachment}`. |
| `pscAllowedProjects[]` | `string` Optional. Additional allowed projects for setting up PSC connections. Instance host project is automatically allowed and does not need to be included in this list. |
| `customHostConfig` | ``object (`https://docs.cloud.google.com/secure-source-manager/docs/reference/rest/v1/projects.locations.instances#CustomHostConfig`)`` Optional. Custom host config for the instance. |

## CustomHostConfig

Custom host config for the instance.

| JSON representation |
|---|
| ``` { "html": string, "api": string, "gitSsh": string, "gitHttp": string } ``` |

| Fields ||
|---|---|
| `html` | `string` Required. The custom UI hostname for the instance, e.g., "git.source.internal.mycompany.com" |
| `api` | `string` Required. The custom API hostname for the instance, e.g., "api.source.internal.mycompany.com" |
| `gitSsh` | `string` Required. The custom git ssh hostname for the instance, e.g., "ssh.source.internal.mycompany.com" |
| `gitHttp` | `string` Required. The custom git http hostname for the instance, e.g., "git.source.internal.mycompany.com" |

## State

Secure Source Manager instance state.

| Enums ||
|---|---|
| `STATE_UNSPECIFIED` | Not set. This should only be the case for incoming requests. |
| `CREATING` | Instance is being created. |
| `ACTIVE` | Instance is ready. |
| `DELETING` | Instance is being deleted. |
| `PAUSED` | Instance is paused. |
| `UNKNOWN` | Instance is unknown, we are not sure if it's functioning. |

## StateNote

Provides information about the current instance state.

| Enums ||
|---|---|
| `STATE_NOTE_UNSPECIFIED` | STATE_NOTE_UNSPECIFIED as the first value of State. |
| `PAUSED_CMEK_UNAVAILABLE` | CMEK access is unavailable. |
| `INSTANCE_RESUMING` | INSTANCE_RESUMING indicates that the instance was previously paused and is under the process of being brought back. > [!WARNING] > This item is deprecated! |

## HostConfig

HostConfig has different instance endpoints.

| JSON representation |
|---|
| ``` { "html": string, "api": string, "gitHttp": string, "gitSsh": string } ``` |

| Fields ||
|---|---|
| `html` | `string` Output only. HTML hostname. |
| `api` | `string` Output only. API hostname. |
| `gitHttp` | `string` Output only. Git HTTP hostname. |
| `gitSsh` | `string` Output only. Git SSH hostname. |

## WorkforceIdentityFederationConfig

WorkforceIdentityFederationConfig allows this instance to support users from external identity providers.

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

| Fields ||
|---|---|
| `enabled` | `boolean` Optional. Immutable. Whether Workforce Identity Federation is enabled. |

| ## Methods ||
|---|---|
| ### `https://docs.cloud.google.com/secure-source-manager/docs/reference/rest/v1/projects.locations.instances/create` | Creates a new instance in a given project and location. |
| ### `https://docs.cloud.google.com/secure-source-manager/docs/reference/rest/v1/projects.locations.instances/delete` | Deletes a single instance. |
| ### `https://docs.cloud.google.com/secure-source-manager/docs/reference/rest/v1/projects.locations.instances/get` | Gets details of a single instance. |
| ### `https://docs.cloud.google.com/secure-source-manager/docs/reference/rest/v1/projects.locations.instances/getIamPolicy` | Gets the access control policy for a resource. |
| ### `https://docs.cloud.google.com/secure-source-manager/docs/reference/rest/v1/projects.locations.instances/list` | Lists Instances in a given project and location. |
| ### `https://docs.cloud.google.com/secure-source-manager/docs/reference/rest/v1/projects.locations.instances/setIamPolicy` | Sets the access control policy on the specified resource. |
| ### `https://docs.cloud.google.com/secure-source-manager/docs/reference/rest/v1/projects.locations.instances/testIamPermissions` | Returns permissions that a caller has on the specified resource. |