Method: projects.locations.corpora.indexes.delete

Delete a single Index. In order to delete an index, the caller must make sure that it is not deployed to any index endpoint.

HTTP request

DELETE https://visionai.googleapis.com/v1/{name=projects/*/locations/*/corpora/*/indexes/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The name of the index to delete. Format: projects/{project_number}/locations/{location}/corpora/{corpus}/indexes/{index}

Request body

The request body must be empty.

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 name resource:

  • visionai.indexes.delete

For more information, see the IAM documentation.