Method: projects.locations.indexEndpoints.deployIndex

Deploys an Index to IndexEndpoint.

HTTP request

POST https://visionai.googleapis.com/v1/{indexEndpoint=projects/*/locations/*/indexEndpoints/*}:deployIndex

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
indexEndpoint

string

Required. IndexEndpoint the index is deployed to. 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. Index to deploy.

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:

  • visionai.indexEndpoints.deploy

For more information, see the IAM documentation.