Create Clerk machine scope

Grant one machine access to another machine in a connected Clerk instance.

← All Clerk endpoints · Capability overview

POST/v1/clerk/machines/{machine_id}/scopes

https://api.vee3.io/v1/clerk/machines/{machine_id}/scopes

8 tokens

Grant one machine access to another machine in a connected Clerk instance.

Authorization

Send your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

MCP

The same capability is available as an MCP tool on Vee3 hosted MCP.

Tool name

clerk.create_machine_scope

Parameters3 fields

clerk_instance_idstringOptional

Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

machine_idstringRequired

Clerk machine id (mch_...) to retrieve or modify.

to_machine_idstringRequired

Target machine id (mch_...) to grant access to.

Response5 fields

machine_scopeobject

4 fields

Created machine scope from the Backend API.

objectstring

Object type (machine_scope).

from_machine_idstring

Machine id that was granted access.

to_machine_idstring

Machine id that can be accessed.

created_atinteger

Unix timestamp in milliseconds when the scope was created.

HTTP errors: clerk_connection_required, clerk_connection_not_found, clerk_connection_invalid, validation_error, unauthorized, payment_required

Example request

Python

import requests

url = "https://api.vee3.io/v1/clerk/machines/{machine_id}/scopes"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "machine_id": "mch_2abc123",
    "to_machine_id": "mch_peer456"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Machine scope granting access between machines.

created_machine_scope.json

{
  "machine_scope": {
    "object": "machine_scope",
    "from_machine_id": "mch_2abc123",
    "to_machine_id": "mch_2def456",
    "created_at": 1710000000000
  }
}