gcloud alpha ai index-endpoints undeploy-index

NAME
gcloud alpha ai index-endpoints undeploy-index - undeploy an index from a Vertex AI index endpoint
SYNOPSIS
gcloud alpha ai index-endpoints undeploy-index(INDEX_ENDPOINT :--region=REGION)--deployed-index-id=DEPLOYED_INDEX_ID[GCLOUD_WIDE_FLAG …]
EXAMPLES
To undeploy the deployed-indexdeployed-index-345 from an index endpoint456 under projectexample in regionus-central1, run:
gcloudalphaaiindex-endpointsundeploy-index456--project=example--region=us-central1--deployed-index-id=deployed-index-345
POSITIONAL ARGUMENTS
Index endpoint resource - The index endpoint to undeploy an index. The argumentsin this group can be used to specify the attributes of this resource. (NOTE)Some attributes are not given arguments in this group but can be set in otherways.

To set theproject attribute:

  • provide the argumentindex_endpoint on the command line with afully specified name;
  • provide the argument--project on the command line;
  • set the propertycore/project.

This must be specified.

INDEX_ENDPOINT
ID of the index_endpoint or fully qualified identifier for the index_endpoint.

To set thename attribute:

  • provide the argumentindex_endpoint on the command line.

This positional argument must be specified if any of the other arguments in thisgroup are specified.

--region=REGION
Cloud region for the index_endpoint.

To set theregion attribute:

  • provide the argumentindex_endpoint on the command line with afully specified name;
  • provide the argument--region on the command line;
  • set the propertyai/region;
  • choose one from the prompted list of available regions.
REQUIRED FLAGS
--deployed-index-id=DEPLOYED_INDEX_ID
Id of the deployed index.
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 help for details.

NOTES
This command is currently in alpha and might change without notice. If thiscommand fails with API permission errors despite specifying the correct project,you might be trying to access an API with an invitation-only early accessallowlist. These variants are also available:
gcloudaiindex-endpointsundeploy-index
gcloudbetaaiindex-endpointsundeploy-index

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-09-16 UTC.