Document Indexes

Update Document Index

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.
label
stringOptional
A human-readable label for the document index
status
enumOptional

The current status of the document index

  • ACTIVE - Active
  • ARCHIVED - Archived
Allowed values: ACTIVEARCHIVED
environment
enumOptional

The environment this document index is used in

  • DEVELOPMENT - Development
  • STAGING - Staging
  • PRODUCTION - Production
Allowed values: DEVELOPMENTSTAGINGPRODUCTION

Response

This endpoint returns an object
id
string
created
datetime
label
string
A human-readable label for the document index
name
string
A name that uniquely identifies this index within its workspace
indexing_config
object
status
enumOptional

The current status of the document index

  • ACTIVE - Active
  • ARCHIVED - Archived
Allowed values: ACTIVEARCHIVED
environment
enumOptional

The environment this document index is used in

  • DEVELOPMENT - Development
  • STAGING - Staging
  • PRODUCTION - Production
Allowed values: DEVELOPMENTSTAGINGPRODUCTION
Built with