Method: projects.locations.indexEndpoints.deployIndex

Deploys an Index into this IndexEndpoint, creating a DeployedIndex within it. Only non-empty Indexes can be deployed.

HTTP request

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

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

Path parameters

Parameters
indexEndpoint

string

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

Request body

The request body contains data with the following structure:

JSON representation
{
  "deployedIndex": {
    object (DeployedIndex)
  }
}
Fields
deployedIndex

object (DeployedIndex)

Required. The DeployedIndex to be created within 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.deploy

For more information, see the IAM documentation.