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

Retrieve a machine

Retrieves the details of a machine. Use its machine_id to identify the machine whose configuration and scopes you need to inspect.

1 parameter
machine_idstringrequired
The ID of the machine to retrieve.

6 status codes
200Returns the machine's ID, name, instance ID, creation and update timestamps, default token TTL when set, and scoped machine IDs.
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.
400Returned when the request is not successful.
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
401Returned when authentication is invalid.
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
403Returned when authorization is invalid.
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
404Returned when the machine resource is not found.
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
422Returned when request parameters are invalid.
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional

Error handling

A 400 indicates the request was not successful, a 401 indicates invalid authentication, a 403 indicates invalid authorization, a 404 indicates the resource was not found, and a 422 indicates invalid request parameters. The machine_id path parameter must identify a machine.