Update Document Index

Beta
PATCH

Used to partial update a Document Index given its ID or name.

Path parameters

idstringRequired

Either the Document Index’s ID or its unique name

Request

This endpoint expects an object.
labelstringOptional

A human-readable label for the document index

status"ACTIVE" or "ARCHIVED"Optional
Allowed values: ACTIVEARCHIVED

The current status of the document index

  • ACTIVE - Active
  • ARCHIVED - Archived
environmentenumOptional
Allowed values: DEVELOPMENTSTAGINGPRODUCTION

The environment this document index is used in

  • DEVELOPMENT - Development
  • STAGING - Staging
  • PRODUCTION - Production

Response

This endpoint returns an object.
idstring
createddatetime
labelstring

A human-readable label for the document index

namestring

A name that uniquely identifies this index within its workspace

indexing_configobject
status"ACTIVE" or "ARCHIVED"Optional
Allowed values: ACTIVEARCHIVED

The current status of the document index

  • ACTIVE - Active
  • ARCHIVED - Archived
environmentenumOptional
Allowed values: DEVELOPMENTSTAGINGPRODUCTION

The environment this document index is used in

  • DEVELOPMENT - Development
  • STAGING - Staging
  • PRODUCTION - Production
Built with