- NAME
-
- gcloud beta ai index-endpoints create - create a new Vertex AI index endpoint
- SYNOPSIS
-
-
gcloud beta ai index-endpoints create--display-name=DISPLAY_NAME[--description=DESCRIPTION] [--enable-private-service-connect] [--encryption-kms-key-name=ENCRYPTION_KMS_KEY_NAME] [--labels=[KEY=VALUE, …]] [--network=NETWORK] [--project-allowlist=[PROJECTS, …]] [--public-endpoint-enabled] [--region=REGION] [GCLOUD_WIDE_FLAG …]
-
- EXAMPLES
- To create an index endpoint under project
examplewith networkprojects/123/global/networks/test-networkin regionus-central1, run:gcloud beta ai index-endpoints create --display-name = index-endpoint --description = test --network = projects/123/global/networks/test-network --project = example --region = us-central1 - REQUIRED FLAGS
-
-
--display-name=DISPLAY_NAME - Display name of the index endpoint.
-
- OPTIONAL FLAGS
-
-
--description=DESCRIPTION - Description of the index endpoint.
-
--enable-private-service-connect - If true, expose the index endpoint via private service connect.
-
--encryption-kms-key-name=ENCRYPTION_KMS_KEY_NAME - The Cloud KMS resource identifier of the customer managed encryption key used to
protect a resource. Has the form:
projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key.
The key needs to be in the same region as where the compute resource is created.
-
--labels=[KEY=VALUE,…] - List of label KEY=VALUE pairs to add.
Keys must start with a lowercase character and contain only hyphens (
-), underscores (_), lowercase characters, and numbers. Values must contain only hyphens (-), underscores (_), lowercase characters, and numbers. -
--network=NETWORK - The Google Compute Engine network name to which the IndexEndpoint should be peered.
-
--project-allowlist=[PROJECTS,…] - List of projects from which the forwarding rule will target the service attachment.
-
--public-endpoint-enabled - If true, the deployed index will be accessible through public endpoint.
- Region resource - Cloud region to create index endpoint. This represents a Cloud
resource. (NOTE) Some attributes are not given arguments in this group but can
be set in other ways.
To set the
projectattribute:- provide the argument
--regionon the command line with a fully specified name; - set the property
ai/regionwith a fully specified name; - choose one from the prompted list of available regions with a fully specified name;
- provide the argument
--projecton the command line; - set the property
core/project.
- provide the argument
-
--region=REGION - ID of the region or fully qualified identifier for the region.
To set the
regionattribute:- provide the argument
--regionon the command line; - set the property
ai/region; - choose one from the prompted list of available regions.
- provide the argument
-
- GCLOUD WIDE FLAGS
- These flags are available to all commands:
--access-token-file,--account,--billing-project,--configuration,--flags-file,--flatten,--format,--help,--impersonate-service-account,--log-http,--project,--quiet,--trace-token,--user-output-enabled,--verbosity.Run
$ gcloud helpfor details. - NOTES
- This command is currently in beta and might change without notice. These
variants are also available:
gcloud ai index-endpoints creategcloud alpha ai index-endpoints create
gcloud beta ai index-endpoints create
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-05-27 UTC.

