Clerk API (unofficial showcase)
GET/machines

Get a list of machines for an instance

This request returns the list of machines for an instance. The machines are ordered by descending creation date (i.e. most recent machines will be returned first)

4 parameters
limitintegeroptional
Applies a limit to the number of results returned. Can be used for paginating the results together with `offset`.
Default:10
offsetintegeroptional
Skip the first `offset` results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with `limit`.
Default:0
querystringoptional
Returns machines with ID or name that match the given query. Uses exact match for machine ID and partial match for name.
order_bystringoptional
Allows to return machines in a particular order. You can order the returned machines by their `name` or `created_at`. To specify the direction, use the `+` or `-` symbols prepended to the property to order by. For example, to return machines in descending order by `created_at`, use `-created_at`. If you don't use `+` or `-`, then `+` is implied. Defaults to `-created_at`.
Default:-created_at

5 status codes
200Success
dataarray<object>required
total_countintegerrequired
Total number of machines
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
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 422 is returned: Invalid request parameters.