Skip to main content

create()

Creates a new machine.

Returns the created Machine object.

function create(bodyParams: CreateMachineParams): Promise<Machine>

CreateMachineParams

  • 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
    name
    Type
    string
    Description

    The name of the machine.

  • Name
    scopedMachines?
    Type
    string[]
    Description

    An array of machine IDs that the new machine will have access to. Maximum of 150 scopes per 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.

Basic machine creation

const response = await clerkClient.machines.create({
  name: 'Email Server',
})

Machine with scoped access

const response = await clerkClient.machines.create({
  name: 'API Gateway',
  scopedMachines: ['mch_123', 'mch_456'],
  defaultTokenTtl: 3600,
})

Backend API (BAPI) endpoint

This method in the SDK is a wrapper around the BAPI endpoint POST/machines. See the BAPI reference for more information.

Feedback

What did you think of this content?

Last updated on

GitHubEdit on GitHub