Skip to main content

updateInstance

codebolt.eventLog.updateInstance(instanceId: undefined, updates: undefined): Promise<EventLogInstanceResponse>

Updates the name or description of an event log instance.

Parameters​

  • instanceId (unknown): The unique identifier of the event log instance.
  • updates (unknown): Object containing name and/or description to update.

Returns​

  • Promise<[EventLogInstanceResponse](/docs/reference/type-reference/codeboltjs/interfaces/EventLogInstanceResponse)>: A promise that resolves with the updated instance details.

Examples​

Example 1: Update Instance Name​

const result = await codebolt.eventLog.updateInstance(
  'log-instance-id',
  { name: 'production-user-activity' }
);

Example 2: Update Description​

const result = await codebolt.eventLog.updateInstance(
  'log-instance-id',
  { description: 'Updated description reflecting new usage patterns' }
);

Notes​

  • Only name and description can be updated
  • Instance data (events) is not affected