---
title: "POST /v1/{+parent}/indexes"
method: POST
path: "/v1/{+parent}/indexes"
tags: ["projects"]
---

# POST /v1/{+parent}/indexes

`POST /v1/{+parent}/indexes`

Creates an Index.

## Path parameters

- `parent` string, required

## Request body

- GoogleCloudAiplatformV1Index — A representation of a collection of database items organized in a way that allows for approximate nearest neighbor (a.k.a ANN) algorithms search.
  - `indexUpdateMethod` 'INDEX_UPDATE_METHOD_UNSPECIFIED' | 'BATCH_UPDATE' | 'STREAM_UPDATE' — Immutable. The update method to use with this Index. If not set, BATCH_UPDATE will be used by default.
  - `satisfiesPzs` boolean — Output only. Reserved for future use.
  - `encryptionSpec` GoogleCloudAiplatformV1EncryptionSpec — Represents a customer-managed encryption key specification that can be applied to a Vertex AI resource.
    - `kmsKeyName` string — Required. Resource name of the Cloud KMS key used to protect the resource. The Cloud KMS key must be in the same region as the resource. It must have the format `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.
  - `displayName` string — Required. The display name of the Index. The name can be up to 128 characters long and can consist of any UTF-8 characters.
  - `deployedIndexes` GoogleCloudAiplatformV1DeployedIndexRef[] — Output only. The pointers to DeployedIndexes created from this Index. An Index can be only deleted if all its DeployedIndexes had been undeployed first.
    - `indexEndpoint` string — Immutable. A resource name of the IndexEndpoint.
    - `deployedIndexId` string — Immutable. The ID of the DeployedIndex in the above IndexEndpoint.
    - `displayName` string — Output only. The display name of the DeployedIndex.
  - `satisfiesPzi` boolean — Output only. Reserved for future use.
  - `name` string — Output only. The resource name of the Index.
  - `description` string — The description of the Index.
  - `updateTime` string, google-datetime — Output only. Timestamp when this Index was most recently updated. This also includes any update to the contents of the Index. Note that Operations working on this Index may have their Operations.metadata.generic_metadata.update_time a little after the value of this timestamp, yet that does not mean their results are not already reflected in the Index. Result of any successfully completed Operation on the Index is reflected in it.
  - `labels` object — The labels with user-defined metadata to organize your Indexes. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
  - `etag` string — Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
  - `metadata` unknown
  - `createTime` string, google-datetime — Output only. Timestamp when this Index was created.
  - `metadataSchemaUri` string — Immutable. Points to a YAML file stored on Google Cloud Storage describing additional information about the Index, that is specific to it. Unset if the Index does not have any additional information. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
  - `indexStats` GoogleCloudAiplatformV1IndexStats — Stats of the Index.
    - `shardsCount` integer — Output only. The number of shards in the Index.
    - `vectorsCount` string, int64 — Output only. The number of dense vectors in the Index.
    - `sparseVectorsCount` string, int64 — Output only. The number of sparse vectors in the Index.

## Response `200`

Successful response

---

[API](https://skmtc.net/google/apis/aiplatform.md) · [All operations](https://skmtc.net/google/apis/aiplatform/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/google/aiplatform/versions/b608d71b91f0/schema)