Search + K

Command Palette

Search for a command to run...

Sign In

Update Vectorize Index (Deprecated)

Deprecated
PUT /accounts/{account_id}/vectorize/indexes/{index_name}
Copy endpoint
https://api.cloudflare.com/client/v4

Updates and returns the specified Vectorize Index.

Parameters

path Path Parameters

Name Type
account_id required
type VectorizeIdentifier = string
index_name required
type VectorizeIndexName = string

Request Body

application/json required
interface VectorizeUpdateIndexRequest {
description: VectorizeIndexDescription

Specifies the description of the index.

type VectorizeIndexDescription = string
;
}

Responses

200 application/json

Update Vectorize Index Response

type VectorizeApiResponseSingle = never & { result?: VectorizeCreateIndexResponse
interface VectorizeCreateIndexResponse {
config?: VectorizeIndexDimensionConfiguration;
created_on?: string;
description?: VectorizeIndexDescription;
modified_on?: string;
name?: VectorizeIndexName;
}
; }

Client Errors

4XX application/json

Update Vectorize Index Failure Response

type VectorizeApiResponseSingle = never & { result?: {} | null; } & interface VectorizeApiResponseCommonFailure {
errors: VectorizeMessages
type VectorizeMessages = { code: number;message: string; }[]
;
messages: VectorizeMessages
type VectorizeMessages = { code: number;message: string; }[]
;
result: null;
success: false;
}