Method: projects.locations.indexEndpoints.get

Gets an IndexEndpoint.

HTTP request

GET https://{service-endpoint}/v1/{name}

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

Path parameters



Required. The name of the IndexEndpoint resource. Format: projects/{project}/locations/{location}/indexEndpoints/{indexEndpoint}

Request body

The request body must be empty.

Response body

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

Authorization scopes

Requires the following OAuth scope:


For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • aiplatform.indexEndpoints.get

For more information, see the IAM documentation.