SitesRfdiags

updateSiteRfdiagRecording

PUT
/api/v1/sites/{site_id}/rfdiags/{rfdiag_id}

Update Recording

Authorization

Authorization<token>

Preferred authentication method for automation and integrations. Send the API token in the HTTP Authorization header.

Format: Authorization: Token {apitoken}

Notes:

  • An API token generated for a specific admin has the same privileges as that admin
  • An API token is automatically removed if it is not used for more than 90 days
  • SSO admins cannot generate admin API tokens. Use organization API tokens when scoped Org/Site privileges are needed.

In: header

Path Parameters

site_id*string
Formatuuid
rfdiag_id*string
Formatuuid

Request Body

application/json

Request Body

RF diagnostic recording request

duration?integer

Recording length, in seconds; maximum and default are 180

Rangevalue <= 180
Default180
mac?string

If type==client or asset, MAC address of the device being recorded

name*string

Recording name; the SDK client name is a good default for SDK-client recordings

sdkclient_id?string

If type==sdkclient, SDK client identifier for this recording

Formatuuid
type*rf_client_type

Target device category for the RF diagnostic recording. enum: asset, client, sdkclient.

Value in

  • "asset"
  • "client"
  • "sdkclient"

Response Body

curl -X PUT "https://example.com/api/v1/sites/000000ab-00ab-00ab-00ab-0000000000ab/rfdiags/000000ab-00ab-00ab-00ab-0000000000ab" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "type": "asset"  }'
[  {    "asset_id": "b069b358-4c97-5319-1f8c-7c5ca64d6ab1",    "asset_name": "string",    "client_name": "string",    "duration": 0,    "end_time": 0,    "frame_count": 0,    "id": "b069b358-4c97-5319-1f8c-7c5ca64d6ab1",    "mac": "string",    "map_id": "b069b358-4c97-5319-1f8c-7c5ca64d6ab1",    "name": "string",    "next": "string",    "raw_events": "string",    "ready": true,    "sdkclient_id": "b069b358-4c97-5319-1f8c-7c5ca64d6ab1",    "sdkclient_name": "string",    "sdkclient_uuid": "b069b358-4c97-5319-1f8c-7c5ca64d6ab1",    "start_time": 0,    "type": "sdkclient",    "url": "string"  }]