Skip to main content
POST
Register an Iroh Endpoint for an Organization

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

org_name
string
required

Organization Name

Body

application/json

Iroh Endpoint registration request body

POST body for registering an Iroh Endpoint against an Organization

identifier
string
required

The endpoint id — the public key the endpoint proves it holds, not a ticket or a relay url

details
object

Anything worth recording alongside the key. Non-authoritative, and never a secret

instance
string
default:default

Names which endpoint this is, for something running more than one. Omit for a single one

user_email
string | null

Attach the endpoint to this member of the organization — their laptop, say. Omit for one the organization holds directly, or for a device that will claim it on its next connection. The address must belong to a member

Response

Iroh Endpoint

Iroh Endpoint show response

data
IrohEndpoint · object

An iroh endpoint id registered to an organization

Example: