Skip to main content

update()

Updates the given machine.

Returns the updated Machine object.

function update(params: UpdateMachineParams): Promise<Machine>

UpdateMachineParams

  • Name
    defaultTokenTtl?
    Type
    number
    Description

    The default time-to-live (TTL) in seconds for tokens created by this machine. Must be at least 1 second.

  • Name
    machineId
    Type
    string
    Description

    The ID of the machine to update.

  • Name
    name?
    Type
    string
    Description

    The name of the machine.

Usage

Note

Using clerkClient varies based on the SDK you're using. Refer to the overview for usage details, including guidance on how to access the userId and other properties.

const machineId = 'mch_123'

const response = await clerkClient.machines.update({
  machineId,
  name: 'New Machine Name',
  defaultTokenTtl: 3600,
})

Backend API (BAPI) endpoint

This method in the SDK is a wrapper around the BAPI endpoint PATCH/machines/{machine_id}. See the BAPI reference for more information.

Feedback

What did you think of this content?

Last updated on

GitHubEdit on GitHub