List indexes

GET

/organizations/{organization}/indexes

Code sample: Shell / cURL

curl --request GET \
  --url 'https://api.grepvine.ai/v1/organizations/example/indexes?amount=50' \
  --cookie __Host-grepvine-session=<__Host-grepvine-session>

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}$/

Query Parameters

amount

integer

default: 50 >= 1 <= 200

page

string

<= 4096 characters

prefix

string

<= 63 characters

Lists only the indexes whose names start with this literal prefix, compared without regard to case. A page token is valid only with the prefix it was issued for.

Responses

200

A page of indexes, ordered by name. Document counts, sizes and last write times can trail the most recent writes by a few seconds; read one index for its current values.

Media typeapplication/json

object

results

required

Array<object>

An index as a listing returns it.

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

pagination

required

A page may hold fewer results than the requested amount, possibly none, while has_next is true; a query page stops at the server’s soft time budget and next_page_id resumes exactly after the last candidate it examined. Clients continue while has_next is true.

object

next_page_id

required

string

has_next

required

boolean

Example

{
  "results": [
    {
      "state": "creating"
    }
  ]
}

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.