Update Directory

Update directory metadata.

patch/api/v1/beta/directories/{directory_id}

Path parameters

directory_idstring required

Query parameters

project_idstring uuid nullable

organization_idstring uuid nullable

Cookies

sessionstring nullable

Request body

namestring nullable

Updated name for the directory.

descriptionstring nullable

Updated description for the directory.

Response

Successful Response

idstring required

Unique identifier for the directory.

created_atstring date-time nullable

Creation datetime

updated_atstring date-time nullable

Update datetime

project_idstring required

Project the directory belongs to.

namestring required

Human-readable name for the directory.

descriptionstring nullable

Optional description shown to users.

type'user' | 'index' | 'ephemeral' | 'system_ephemeral' nullable

Directory type: 'user', 'index', 'ephemeral', or 'system_ephemeral'.

expires_atstring date-time nullable

When this directory expires and is eligible for cleanup.

system_metadataobject nullable

Reserved system-managed metadata.

deleted_atstring date-time nullable

Optional timestamp of when the directory was deleted. Null if not deleted.

Changes

Changed in 7 of the 33 revisions of this API.37

Jun 9, 2026b17341164de92See the full diff
- ○
  added the optional property detail/items/ctx to the response with the 422 status
  response-optional-property-added
- ○
  added the optional property detail/items/input to the response with the 422 status
  response-optional-property-added
This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
May 27, 20261c29e1491a383See the full diff
- ○
  added the optional property expires_at to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property system_metadata to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property type to the response with the 200 status
  response-optional-property-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
May 23, 202634da5826db1c1See the full diff
- ●
  removed the optional property data_source_id from the response with the 200 status
  response-optional-property-removed
May 21, 2026fb63fb8d662c1See the full diff
- ○
  added the optional property data_source_id to the response with the 200 status
  response-optional-property-added
This revision also has 46 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
May 16, 2026c317ed7c691a1See the full diff
- ●
  removed the optional property data_source_id from the response with the 200 status
  response-optional-property-removed
May 14, 20261bbc901f8c0d1See the full diff
- ○
  added the optional property data_source_id to the response with the 200 status
  response-optional-property-added
This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
May 12, 2026548a0c57fdd61See the full diff
- ●
  removed the optional property data_source_id from the response with the 200 status
  response-optional-property-removed

Full history