Update an index

Update an index.

When an index is updated, all of the items currently in the list will be re-indexed.

PUT https://api.jsonpad.io/lists/{listId}/indexes/{indexId}

Example

1234567

curl https://api.jsonpad.io/lists/30641f15-4a53-47e3-bb04-a13c073c0d9a/indexes/6300d847-876c-448a-a5cf-9aa0ef6815b2 \
  -X PUT \
  -H "Content-Type: application/json" \
  -H "x-api-token: <YOUR TOKEN>" \
  -d '{
        "name": "My Updated Index"
      }'

Parameters

required
listIdstringA list id or path name.
required
indexIdstringAn index id or path name.

Request headers

required
x-api-tokenstringYour API token.

Request body

{name: "Sample Index"
description: ""
pathName: "sample-index"
pointer: "/name"
valueType: "string"
alias: false
sorting: false
filtering: false
searching: false
defaultOrderDirection: "asc"
activated: true
}

namestringThe name of the index.
descriptionstringA description of the index.
pathNamestringThe path name of the index. This is used in URL query parameters to sort and filter items.
pointerstringA JSON pointer to the field in the item data that the index points to.
valueType'string' | 'number' | 'date'
The type of value that the index points to.
This can be used to sort and filter items in different ways.
Examples
- ?index-name=lt:10 will filter items using the index-name index where the indexed value is a number less than 10.
- ?index-name=lte:10 will filter items using the index-name index where the indexed value is a number less than or equal to 10.
- ?index-name=gt:10 will filter items using the index-name index where the indexed value is a number greater than 10.
- ?index-name=gte:10 will filter items using the index-name index where the indexed value is a number greater than or equal to 10.
- ?index-name=before:2026-09-05 will filter items using the index-name index where the indexed value is a date before (or exactly equal to) 5o September 2026.
- ?index-name=after:2026-09-05 will filter items using the index-name index where the indexed value is a date after (or exactly equal to) 5o September 2026.
aliasbooleanWhether the index is an alias index. Each list can only have one alias index.
sortingbooleanWhether the index can be used for sorting items.
filteringbooleanWhether the index can be used for filtering items.
searchingbooleanWhether the index can be used for searching for items.
defaultOrderDirection'asc' | 'desc'When sorting items using this index, this is the default order direction.
activatedbooleanWhether the item is activated. Inactive indexes are not accessible or usable via the API.

Response body

200 OK

{id: "964c6102-7ba3-48ae-88cb-6c86ee3b49ce"
createdAt: "2026-09-05T11:30:25.587Z"
updatedAt: "2026-09-05T11:30:25.587Z"
name: "Sample Index"
description: ""
pathName: "sample-index"
pointer: "/name"
valueType: "string"
alias: false
sorting: false
filtering: false
searching: false
defaultOrderDirection: "asc"
activated: true
}

Response headers

last-modified2026-09-05T11:30:25.587ZThe date this list was last modified.

2024-10-29