Clerk API (unofficial showcase)
PATCH/machines/{machine_id}

Update a machine

Updates an existing machine. Only the provided fields will be updated.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 2 body fields
machine_idstringrequired
The ID of the machine to update
namestringoptional
The name of the machine
default_token_ttlintegeroptional
The default time-to-live (TTL) in seconds for tokens created by this machine. Must be at least 1 second.

6 status codes
200Success
objectstringrequired
Allowed:machine
idstringrequired
Unique identifier for the machine.
namestringrequired
The name of the machine.
instance_idstringrequired
The ID of the instance this machine belongs to.
created_atintegerrequired
Unix timestamp of creation.
updated_atintegerrequired
Unix timestamp of last update.
default_token_ttlintegeroptional
The default time-to-live (TTL) in seconds for tokens created by this machine.
Default:3600
scoped_machinesarray<object>required
Array of machines this machine has access to.
400Request was not successful
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
401Authentication invalid
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
403Authorization invalid
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
404Resource not found
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
422Invalid request parameters
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional

Error handling

A 400 is returned: Request was not successful. A 401 is returned: Authentication invalid. A 403 is returned: Authorization invalid. A 404 is returned: Resource not found. A 422 is returned: Invalid request parameters.