Update an index

PATCH

/organizations/{organization}/indexes/{index}

Code sample: Shell / cURL

curl --request PATCH \
  --url https://api.grepvine.ai/v1/organizations/example/indexes/example \
  --header 'Content-Type: application/json' \
  --cookie __Host-grepvine-session=<__Host-grepvine-session> \
  --data '{ "description": "example", "tags": { "additionalProperty": "example" } }'

Changes the index’s description or tags. A field absent from the request is left as it is. The name is immutable.

Authorizations

• cookieAuth
• apiKeyAuth

Parameters

Path Parameters

organization

required

An account or organization name. Accounts and organizations share one namespace. A name keeps the case it was created with, and any spelling that differs only in case refers to it; no other account or organization can take such a spelling.

string

/^[A-Za-z][A-Za-z0-9-]{2,62}$/

index

required

An index name, unique in its organization. A name keeps the case it was created with, and any spelling that differs only in case refers to it; no other index in the organization can take such a spelling.

string

/^[A-Za-z][A-Za-z0-9-]{0,62}$/

Header Parameters

X-Csrf-Token

string

>= 16 characters <= 256 characters

Required for a state change that uses cookie authentication.

Request Body^required

Media typeapplication/json

The fields to change. A field that is absent is left as it is; at least one must be present.

object

description

What the index holds, in Markdown. Empty when no description was set. Clients render it without raw HTML.

string

<= 16384 characters

tags

Tags to set, by key, and tags to remove, given as null. A key absent from the map is unchanged.

object

<= 64 properties

key

additional properties

string | null

<= 1024 characters

Example ^generated

{
  "description": "example",
  "tags": {
    "additionalProperty": "example"
  }
}

Responses

200

The updated index.

Media typeapplication/json

An index as a read of that one index returns it, which adds the progress of its background optimization.

object

id

required

string format: uuid

organization

required

An account or organization name. Accounts and organizations share one namespace. A name keeps the case it was created with, and any spelling that differs only in case refers to it; no other account or organization can take such a spelling.

string

/^[A-Za-z][A-Za-z0-9-]{2,62}$/

name

required

An index name, unique in its organization. A name keeps the case it was created with, and any spelling that differs only in case refers to it; no other index in the organization can take such a spelling.

string

/^[A-Za-z][A-Za-z0-9-]{0,62}$/

canonical_id

required

string

description

required

What the index holds, in Markdown. Empty when no description was set. Clients render it without raw HTML.

string

<= 16384 characters

tags

required

Key/value labels on the index, for example the commit it was synced from. At most 64 tags. A key is 1 to 128 characters without whitespace or control characters; a value is at most 1,024 characters without control characters. Empty when none was set.

object

<= 64 properties

key

additional properties

string

<= 1024 characters

state

required

string

Allowed values: creating ready deleting delete_failed

document_count

required

integer

content_bytes

required

integer

created_at

required

string format: date-time

last_updated_at

string format: date-time

optimization_progress_percent

How far the background optimization of this index has progressed, as a percentage. Omitted when no optimization is running.

integer

<= 100

Example

{
  "state": "creating"
}

404

The resource does not exist or is not visible.

Media typeapplication/json

object

code

required

string

reason

required

string

error

required

string

Example ^generated

{
  "code": "example",
  "reason": "example",
  "error": "example"
}

Headers

X-Request-Id

string

The request identifier used for support and audit correlation.

default

The request failed. A 429 carries Retry-After; the index is busy absorbing recent writes or is out of request capacity, and clients must slow down and retry after the interval. A 403 with code organization_suspended refuses every operation on a suspended organization’s members, indexes, documents and searches; reading the organization itself still answers and reports suspended, and the client should contact support.

Media typeapplication/json

object

code

required

string

reason

required

string

error

required

string

Example ^generated

{
  "code": "example",
  "reason": "example",
  "error": "example"
}

Headers

X-Request-Id

string

The request identifier used for support and audit correlation.

Retry-After

integer

Seconds to wait before retrying. Sent with every 429 so a client slows down instead of failing.