Method: projects.locations.indexEndpoints.undeployIndex

Undeploys an Index from an IndexEndpoint, removing a DeployedIndex from it, and freeing all resources it's using.

HTTP request

POST https://{service-endpoint}/v1beta1/{indexEndpoint}:undeployIndex

Where {service-endpoint} is one of the supported service endpoints.

Path parameters

Parameters
indexEndpoint

string

Required. The name of the IndexEndpoint resource from which to undeploy an Index. Format: projects/{project}/locations/{location}/indexEndpoints/{indexEndpoint}

Request body

The request body contains data with the following structure:

JSON representation
{
  "deployedIndexId": string
}
Fields
deployedIndexId

string

Required. The ID of the DeployedIndex to be undeployed from the IndexEndpoint.

Response body

If successful, the response body contains an instance of Operation.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the indexEndpoint resource:

  • aiplatform.indexEndpoints.undeploy

For more information, see the IAM documentation.