Content Management API > Search Index

Search Index

A Search Index is used to index a website to provide DatoCMS Site Search functionality.

Object payload

id string

ID of search_index

Example:

"1822"

type string

Must be exactly "search_index".

attributes.name string

Name of the search index

Example:

"Production Website"

attributes.enabled boolean

Whether the search index is enabled or not

attributes.frontend_url string, null

The public URL of the website. This is the starting point from which the website's spidering will start

Example:

"https://www.mywebsite.com/"

attributes.user_agent_suffix string, null

Optional suffix to append to the DatoCmsSearchBot user agent when indexing the website

Example:

"v1.0.0"

meta.indexing_status enum

Status of the search indexing

Example:

"success"

unstarted

pending

success

failed

meta.last_indexing_completed_at

Timestamp of the last completed indexing

Type: date-time, null

Example:

"2025-03-30T09:29:14.872Z"

relationships.build_triggers.data

The build triggers that can trigger this search index