ETethiack
organizations

Create an organization beacon

Provision a beacon for an organization.

Scoped to organization and partner integrators. Reserves a rathole port and generates a WireGuard configuration; the response carries the server configuration, which is returned exactly once here and never persisted or retrievable again.

Args: organization_id (int): Identifier of the organization. body (CreateBeaconRequest): Beacon name, CIDRs, and optional DNS/interface settings. db (AsyncSession): Request-scoped database session. context (ActiveContext): Resolved caller identity and scope.

Returns: BeaconCreatedResponse: The provisioned beacon and its one-time WireGuard server config.

post/v1/organizations/{organization_id}/beacons/

Request

  • Base URL
    https://api.ethiack.com (the document declares no server; this is the origin it was published from)
  • Auth
    none declared

Path parameters

organization_idinteger required

Request body

namestring required
allowed_cidrsstring[] required
dns_serverstring nullable
interface_namestring nullable

Response

Successful Response

idinteger required
namestring required
statusinteger required
last_seenstring date-time nullable required
createdstring date-time required
allowed_cidrsstring[] nullable
dns_serverstring nullable
interface_namestring nullable
versioninteger required
beacon_tokenstring nullable
rathole_serverstring nullable
rathole_public_portinteger nullable
wireguard_configstring nullable
rathole_control_portinteger required

Rathole control port (always the default)

Changes

No recorded changes to this operation across all 1 revision of this API.