OrgsRF Templates

createOrgRfTemplate

POST
/api/v1/orgs/{org_id}/rftemplates

Create an organization RF template with 2.4, 5, and 6 GHz radio settings, country code, scanning behavior, antenna gain, and model-specific overrides.

To assign a RF template to a site, use the Update Site endpoint and specify the RF template ID in the rftemplate_id field of the request body.

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

org_id*string
Formatuuid

Request Body

application/json

Request Body

RF template used by the current RRM calculation

ant_gain_24?integer

External antenna gain for the 2.4 GHz radio

ant_gain_5?integer

External antenna gain for the 5 GHz radio

ant_gain_6?integer

External antenna gain for the 6 GHz radio

band_24?

2.4 GHz radio settings in this RF template

band_24_usage?radio_band_24_usage

Radio usage mode for the 2.4 GHz-capable radio in this RF template. enum: 24, 5, 6, auto.

Value in

  • "24"
  • "5"
  • "6"
  • "auto"
band_5?

5 GHz radio settings in this RF template

band_5_on_24_radio?

5 GHz radio settings in this RF template

band_6?

6 GHz radio settings in this RF template

country_code?string

Optional, country code to use. If specified, this gets applied to all sites using the RF Template

enable_unii_4?boolean

Whether U-NII-4 channels (169, 173, 177) are enabled

Defaultfalse
model_specific?

overwrites for a specific model. If a band is specified, it will shadow the default. Property key is the model name (e.g. "AP63")

name*string

The name of the RF template

scanning_enabled?boolean

Whether scanning radio is enabled

Response Body

curl -X POST "https://example.com/api/v1/orgs/000000ab-00ab-00ab-00ab-0000000000ab/rftemplates" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'
{  "ant_gain_24": 0,  "ant_gain_5": 0,  "band_24": {    "allow_rrm_disable": true,    "ant_gain": 0,    "bandwidth": 20,    "channels": [      1,      6,      11    ],    "disabled": false,    "power_max": 11,    "power_min": 3,    "preamble": "short"  },  "band_24_usage": "auto",  "band_5": {    "allow_rrm_disable": false,    "ant_gain": 0,    "bandwidth": 80,    "channels": [      36,      40,      44,      48,      52,      56,      60,      64,      100,      104,      149,      153,      157,      161    ],    "disabled": false,    "power_max": 16,    "power_min": 9,    "preamble": "short"  },  "country_code": "FR",  "created_time": 1594743723,  "enable_unii_4": false,  "id": "b3f20330-f76a-49f1-bc65-0d8727140b1d",  "model_specific": {},  "modified_time": 1613582192,  "name": "Lab",  "org_id": "203d3d02-dbc0-4c1b-9f41-76896a3330f4"}