Packets

Decode Packets

Synchronously decode and decrypt a small batch of BLE advertisement packets for your organization.

Required Scope: read-packets

The input advertisements are also forwarded to the asynchronous ingest pipeline (the same pipeline used by GET /v1/org/{org_id}/packets) so that packets are persisted regardless of the synchronous decode outcome.

Only packets that successfully decode and that belong to the calling organization are returned in the response. Packets that fail to decode, or that belong to a different organization, are omitted from the response and are instead handled by the asynchronous pipeline.

Limits

  • Maximum 25 advertisements per request.
post/v1/org/{org_id}/packets/decode

Request

  • Base URL: https://api.hubble.com
  • URL: https://api.hubble.com/v1/org/{org_id}/packets/decode
  • Auth: HTTP bearer

Path parameters

org_idstring uuid required

The ID for an organization

Your organization ID

Headers

Content-Typestring

An indication that the payload is JSON

Request body

Response

A batch of decoded packets belonging to the calling organization.

Example response

{
  "packets": [
    {
      "device": {
        "tags": {
          "_env": "production"
        }
      },
      "gateway": {
        "service_id": "fca6"
      }
    }
  ]
}

Changes

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