organizations

Update an organization's beacon

Update a beacon belonging to an organization.

Scoped to organization and partner integrators. Changes to the CIDR or DNS settings re-patch the stored client configurations.

Args: organization_id (int): Identifier of the organization. beacon_id (int): Primary key of the beacon. body (UpdateBeaconRequest): Fields to change; omitted fields are left unchanged. db (AsyncSession): Request-scoped database session. context (ActiveContext): Resolved caller identity and scope.

Returns: BeaconDetailResponse: The updated beacon.

patch/v1/organizations/{organization_id}/beacons/{beacon_id}

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
beacon_idinteger required

Request body

namestring nullable
allowed_cidrsstring[] nullable
dns_serverstring 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
rathole_control_portinteger required

Rathole control port (always the default)

Changes

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