Search Index Registry

The search index registry resource.

Basehttps://rest.carbon.ms/searchIndexRegistry

GET/searchIndexRegistry

List search index registrys

Retrieve a paginated list of search index registrys. Filter, order, and select columns with PostgREST query parameters.

Query parameters

selectstring

Comma-separated columns to return. Defaults to all.

orderstring

Column to sort by, e.g. `createdAt.desc`.

limitinteger

Maximum rows to return.

offsetinteger

Rows to skip, for pagination.

GEThttps://rest.carbon.ms/searchIndexRegistry

curl --request GET \
  --url 'https://rest.carbon.ms/searchIndexRegistry?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'

Response

[
  {
    "companyId": "xyz789",
    "createdAt": "2026-01-01T00:00:00Z",
    "lastRebuiltAt": "2026-01-01T00:00:00Z"
  }
]

GET/searchIndexRegistry

Retrieve a search index registry

Fetch a single search index registry by filtering on `companyId`.

Query parameters

companyIdstring

Match on the search index registry's `companyId`, e.g. `eq.{id}`.

GEThttps://rest.carbon.ms/searchIndexRegistry

curl --request GET \
  --url 'https://rest.carbon.ms/searchIndexRegistry?companyId=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

Response

{
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z",
  "lastRebuiltAt": "2026-01-01T00:00:00Z"
}

POST/searchIndexRegistry

Create a search index registry

Create a new search index registry.

Body parameters

lastRebuiltAttimestamp

POSThttps://rest.carbon.ms/searchIndexRegistry

curl --request POST \
  --url https://rest.carbon.ms/searchIndexRegistry \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"companyId":"xyz789"}'

Response

{
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z",
  "lastRebuiltAt": "2026-01-01T00:00:00Z"
}

PATCH/searchIndexRegistry

Update a search index registry

Update an existing search index registry, matched on `companyId`.

Body parameters

lastRebuiltAttimestamp

PATCHhttps://rest.carbon.ms/searchIndexRegistry

curl --request PATCH \
  --url 'https://rest.carbon.ms/searchIndexRegistry?companyId=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"lastRebuiltAt":"2026-01-01T00:00:00Z"}'

Response

{
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z",
  "lastRebuiltAt": "2026-01-01T00:00:00Z"
}

DELETE/searchIndexRegistry

Delete a search index registry

Delete a search index registry, matched on `companyId`. Returns 204 No Content.

Query parameters

companyIdstring

The `companyId` of the search index registry to delete, e.g. `eq.{id}`.

DELETEhttps://rest.carbon.ms/searchIndexRegistry

curl --request DELETE \
  --url 'https://rest.carbon.ms/searchIndexRegistry?companyId=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

204 No Content