Clerk API (unofficial showcase)
POST/machines/{machine_id}/scopes

Create a machine scope

Creates a new machine scope, allowing the specified machine to access another machine. Maximum of 150 scopes per machine.

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

1 parameter · 1 body field
machine_idstringrequired
The ID of the machine that will have access to another machine
to_machine_idstringrequired
The ID of the machine that will be scoped to the current machine

7 status codes
200Machine scope created successfully for a machine
objectstringrequired
Allowed:machine_scope
from_machine_idstringrequired
The ID of the machine that has access to the target machine.
to_machine_idstringrequired
The ID of the machine that is being accessed.
created_atintegerrequired
Unix timestamp of creation.
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
409Conflict
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 409 is returned: Conflict. A 422 is returned: Invalid request parameters.