---
title: "Update Ai Activate Index Config"
method: PATCH
path: "/ai_activate/indexes/{volume_id}"
tags: ["AI Activate"]
---

# Update Ai Activate Index Config

`PATCH /ai_activate/indexes/{volume_id}`

## Request

- Base URL: `https://am1.portal.api.nasuni.com`
- URL: `https://am1.portal.api.nasuni.com/ai_activate/indexes/{volume_id}`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/nasuni/apis/portal-api/docs/ai_activate/indexes/:volume_id/patch.ts> (a function with typed inputs; its response is checked against the schema)

Partially update the AI Activate search configuration for a volume. Returns 404 if none exists.

Send `deletion_requested: false` to cancel a pending removal — 409 when none is pending,
and 400 once NOC has started tearing the volume down.

## Path parameters

- `volume_id` string, required

## Request body

- AiActivateIndexUpdateDto: PATCH body for ``/ai_activate/indexes/{volume_id}``. Extends the search configuration with the removal flag so only PATCH accepts it — creating an index has no removal to cancel.
  - `include_paths` string[], nullable
  - `exclude_paths` string[], nullable
  - `deletion_requested` boolean, nullable: Set to false to cancel a pending removal. DELETE the index to request one.

## Response `200`

AI Activate index configuration updated

- AiActivateIndexDetailsDto: Full AI Activate index detail for a volume — list-item fields plus search configuration. Returned by the webapi GET/POST/PATCH ``/ai_activate/indexes/{volume_id}`` endpoints so external API consumers see the same volume/index metadata as the list endpoint alongside the search configuration in a single response.
  - `volume_guid` string, required
  - `volume_name` string, required
  - `provider` string, required
  - `volume_region` string, nullable: Storage region of the volume. May be null when NOC has no volume metadata.
  - `status` 'in_progress' | 'complete' | 'failed' | 'queued_for_deletion', required
  - `file_count` integer, nullable: Number of files indexed for the volume. May be null until NOC reports a count.
  - `volume_size` string, nullable: Human-readable volume size string e.g. '10.5 TB'. May be unavailable until indexing progresses.
  - `removal_deadline_at` string, date-time, nullable: Instant after which a requested removal stops being reversible. Null when no removal is pending for the volume, and on NOC deployments that predate the field.
  - `include_paths` string[]
  - `exclude_paths` string[]
  - `mcp_enabled` boolean, nullable

## Other responses

- `400`: Bad request
- `401`: Not authenticated
- `403`: Insufficient permissions
- `404`: Resource not found
- `408`: Request timeout
- `409`: Resource state conflict
- `422`: Invalid input data
- `500`: Internal server error

---

[API](https://skmtc.dev/nasuni/apis/portal-api.md) - [All operations](https://skmtc.dev/nasuni/apis/portal-api/llms.txt) - [OpenAPI document](https://skmtc.dev/nasuni/apis/portal-api/revisions/2a505bec6d14?raw)