# Update a search index

## Body parameters

**`name`**

- Optional
- Type: string
- Example: `"Production Website"`

Name of the search index

**`enabled`**

- Optional
- Type: boolean

Whether the search index is enabled or not

**`frontend_url`**

- Optional
- Type: string, null
- Example: `"https://www.mywebsite.com/"`

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

**`user_agent_suffix`**

- Optional
- Type: string, null
- Example: `"v1.0.0"`

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

**`build_triggers`**

- Optional
- Type: Array<[ResourceLinkage\<"build_trigger"\>](https://www-draft.datocms.com/docs/content-management-api/resources/build_trigger.md)>

The build triggers that can trigger this search index

## Returns

Returns a resource object of type [search\_index](https://www.datocms.com/docs/content-management-api/resources/search-index.md)

## Examples

###### Example Basic example

Code

```javascript
import { buildClient } from "@datocms/cma-client-node";

async function run() {
  const client = buildClient({ apiToken: process.env.DATOCMS_API_TOKEN });

  const searchIndexId = "1822";

  const searchIndex = await client.searchIndexes.update(searchIndexId, {
    id: "1822",
  });

  // Check the 'Returned output' tab for the result ☝️
  console.log(searchIndex);
}

run();
```

Returned output

```javascript
{
  id: "1822",
  name: "Production Website",
  enabled: true,
  frontend_url: "https://www.mywebsite.com/",
  user_agent_suffix: "v1.0.0",
  meta: {
    indexing_status: "success",
    last_indexing_completed_at: "2025-03-30T09:29:14.872Z",
  },
  build_triggers: [{ type: "build_trigger", id: "1822" }],
}
```

## Related content in "Content Management API"

- [Content Management API Overview](https://www.datocms.com/docs/content-management-api.md)
- [Using the JavaScript CMA client](https://www.datocms.com/docs/content-management-api/using-the-nodejs-clients.md)
- [API versioning](https://www.datocms.com/docs/content-management-api/api-versioning.md)
- [Authentication](https://www.datocms.com/docs/content-management-api/authentication.md)
- [Environments](https://www.datocms.com/docs/content-management-api/setting-the-environment.md)
- [Error codes & handling failures (CMA)](https://www.datocms.com/docs/content-management-api/errors.md)
- [Pagination](https://www.datocms.com/docs/content-management-api/pagination.md)
- [Asynchronous jobs](https://www.datocms.com/docs/content-management-api/async-jobs.md)
- [CMA Technical Limits & Rate Limits](https://www.datocms.com/docs/content-management-api/technical-limits.md)
- [Record](https://www.datocms.com/docs/content-management-api/resources/item.md)
- [Scheduled publication](https://www.datocms.com/docs/content-management-api/resources/scheduled-publication.md)
- [Scheduled unpublishing](https://www.datocms.com/docs/content-management-api/resources/scheduled-unpublishing.md)
- [Upload](https://www.datocms.com/docs/content-management-api/resources/upload.md)
- [Site](https://www.datocms.com/docs/content-management-api/resources/site.md)
- [Model/Block model](https://www.datocms.com/docs/content-management-api/resources/item-type.md)
- [Field](https://www.datocms.com/docs/content-management-api/resources/field.md)
- [Fieldset](https://www.datocms.com/docs/content-management-api/resources/fieldset.md)
- [Record version](https://www.datocms.com/docs/content-management-api/resources/item-version.md)
- [Upload permission](https://www.datocms.com/docs/content-management-api/resources/upload-request.md)
- [Upload track](https://www.datocms.com/docs/content-management-api/resources/upload-track.md)
- [Manual tags](https://www.datocms.com/docs/content-management-api/resources/upload-tag.md)
- [Smart tags](https://www.datocms.com/docs/content-management-api/resources/upload-smart-tag.md)
- [Upload Collection](https://www.datocms.com/docs/content-management-api/resources/upload-collection.md)
- [Search Index](https://www.datocms.com/docs/content-management-api/resources/search-index.md)
- [List all search indexes for a site](https://www.datocms.com/docs/content-management-api/resources/search-index/instances.md)
- [Retrieve a search index](https://www.datocms.com/docs/content-management-api/resources/search-index/self.md)
- [Create a search index](https://www.datocms.com/docs/content-management-api/resources/search-index/create.md)
- [Update a search index](https://www.datocms.com/docs/content-management-api/resources/search-index/update.md)
- [Trigger the indexing process](https://www.datocms.com/docs/content-management-api/resources/search-index/trigger.md)
- [Abort a the current indexing process and mark it as failed](https://www.datocms.com/docs/content-management-api/resources/search-index/abort.md)
- [Delete a search index](https://www.datocms.com/docs/content-management-api/resources/search-index/destroy.md)
- [Search result](https://www.datocms.com/docs/content-management-api/resources/search-result.md)
- [Search indexing activity](https://www.datocms.com/docs/content-management-api/resources/search-index-event.md)
- [Environment](https://www.datocms.com/docs/content-management-api/resources/environment.md)
- [Maintenance mode](https://www.datocms.com/docs/content-management-api/resources/maintenance-mode.md)
- [Menu Item](https://www.datocms.com/docs/content-management-api/resources/menu-item.md)
- [Schema Menu Item](https://www.datocms.com/docs/content-management-api/resources/schema-menu-item.md)
- [Uploads filter](https://www.datocms.com/docs/content-management-api/resources/upload-filter.md)
- [Model filter](https://www.datocms.com/docs/content-management-api/resources/item-type-filter.md)
- [Plugin](https://www.datocms.com/docs/content-management-api/resources/plugin.md)
- [Workflow](https://www.datocms.com/docs/content-management-api/resources/workflow.md)
- [Asynchronous job](https://www.datocms.com/docs/content-management-api/resources/job.md)
- [Job result](https://www.datocms.com/docs/content-management-api/resources/job-result.md)
- [Account](https://www.datocms.com/docs/content-management-api/resources/account.md)
- [Organization](https://www.datocms.com/docs/content-management-api/resources/organization.md)
- [Invitation](https://www.datocms.com/docs/content-management-api/resources/site-invitation.md)
- [Collaborator](https://www.datocms.com/docs/content-management-api/resources/user.md)
- [Role](https://www.datocms.com/docs/content-management-api/resources/role.md)
- [API token](https://www.datocms.com/docs/content-management-api/resources/access-token.md)
- [Webhook](https://www.datocms.com/docs/content-management-api/resources/webhook.md)
- [Webhook call](https://www.datocms.com/docs/content-management-api/resources/webhook-call.md)
- [Build trigger](https://www.datocms.com/docs/content-management-api/resources/build-trigger.md)
- [Deploy activity](https://www.datocms.com/docs/content-management-api/resources/build-event.md)
- [Subscription limit](https://www.datocms.com/docs/content-management-api/resources/subscription-limit.md)
- [Subscription feature](https://www.datocms.com/docs/content-management-api/resources/subscription-feature.md)
- [SSO Settings](https://www.datocms.com/docs/content-management-api/resources/sso-settings.md)
- [SSO User](https://www.datocms.com/docs/content-management-api/resources/sso-user.md)
- [SSO Group](https://www.datocms.com/docs/content-management-api/resources/sso-group.md)
- [White-label settings](https://www.datocms.com/docs/content-management-api/resources/white-label-settings.md)
- [Audit log event](https://www.datocms.com/docs/content-management-api/resources/audit-log-event.md)