udp

Where this project's devices send UDP datagrams, and how one is laid out (any member)

The static anycast addresses and port to send to — these never change, so a device hard-codes one. hostname is published too when this deployment has one configured, but it is optional and DNS-only: devices that cannot resolve DNS (most hardware senders) use addresses directly. A datagram is device_id (8) ‖ nonce (nonce_len) ‖ payload ‖ tag (tag_len) and carries NO version, length or delimiter: the widths come from the device's own row, which is why they are published here. The ACK is nonce ‖ status (1) ‖ tag, where status is 0 stored, 1 throttled, 2 disabled. provisioned is false where no listener is configured; the suite table is published either way so a device can be prepared first. rejects_retention is how long a parked datagram stays readable before the prune pass removes it.

get/v1/projects/{project_id}/udp/endpoint

Request

  • Base URL: https://api.wavehouse.cloud
  • URL: https://api.wavehouse.cloud/v1/projects/{project_id}/udp/endpoint
  • Auth: one of:
    • API key in cookie whc_session
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

project_idstring required

Response

OK

addressesstring[] required

the canonical static endpoint: anycast addresses, IPv4 and IPv6, that never change — hard-code one

device_id_leninteger required

leading device-id bytes; the nonce starts here and the payload at device_id_len + nonce_len

hostnamestring

an optional DNS name for this deployment, when configured; addresses are the endpoint, not a fallback

portinteger required
provisionedboolean required

false when this deployment has no UDP listener; the suite table is still published

Changes

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