udp

Stop a UDP device without ending it (owner/admin)

Its datagrams are answered with status 2 (disabled), which tells a well-behaved device to STOP rather than retry — unlike a revoke, which it only sees as silence. Reversible: the key is kept and enable brings it back.

post/v1/projects/{project_id}/udp/devices/{device_id}/disable

Request

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

Path parameters

project_idstring required
device_idstring required

the device's 16-hex-character id

Response

OK

bytes_per_secondinteger required

bytes per second the edge accepts; 0 is unlimited

content_encodingstring

gzip or zstd when the device compresses; empty otherwise

content_typestring required

the media type the payload is posted to the engine under

created_atstring date-time required
created_bystring
enabledboolean required
expires_atstring date-time

absent when the device does not expire

idstring required

16 hex characters — the 8 bytes that lead every datagram

last_seen_atstring date-time

batched: it trails live traffic by up to a minute

namestring required
nonce_leninteger required
rate_per_secondnumber double required

datagrams per second the edge accepts; 0 is unlimited

revoked_atstring date-time

present once revoked

statusstring required

active | disabled | revoked | expired

suitestring required
tablestring required

Changes

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