Skip to content
Configuration Templates/
/
Retrieve Diff Reports

Configuration Templates (1.0.0)

Overview

The Configuration Templates API manages configuration templates in RUCKUS One. It supports creating, applying, enforcing, and monitoring template applications across tenants and to the account itself using the concept of drift.

Template context

  • MSP templates: Core functionality for Managed Service Providers. MSP templates can be applied to MSP_EC (Enterprise Customer) tenants managed by the MSP tenant.
  • REC templates: Templates that can only be applied to the tenant itself (self managed configurations).

MSP templates and REC templates are managed separately and displayed on different pages in the UI. To access REC template endpoints, add the /rec prefix to the API path.

Supported template types

The following configuration types support template functionality: VENUE, NETWORK, RADIUS, DPSK, WIFI_CALLING, DHCP, ACCESS_CONTROL, and others.

Core capabilities

  • Template application: Apply templates to tenants to create instances. Supports overrides for venue templates (name, description, address fields, time zone).
  • Template enforcement: Control whether instances must comply with template configuration or can be modified independently.
  • Drift detection and management:
    • Query instances that have drifted from their template configuration
    • Retrieve diff reports showing differences between templates and instances
    • Sync templates to drift tenants to restore configuration compliance
Download OpenAPI description
Download PDF
Overview
License
RUCKUS Cloud Privacy Policy
Terms of Service
Languages
Servers
RUCKUS One API host for North American region.
https://api.ruckus.cloud
RUCKUS One API host for European region.
https://api.eu.ruckus.cloud
RUCKUS One API host for Asian region.
https://api.asia.ruckus.cloud

Configuration Template

Manage the configuration templates.

Operations

Update Template Enforcement Settings

Request

Update template enforcement settings. Add prefix '/rec' for REC templates.

Path
templateIdstringrequired
Headers
Authorizationstringrequired
Body
required
isEnforcedboolean
{
  "isEnforced": true
}

Responses

Accepted

Body
requestIdstring
Response
{
  "requestId": "b3d3a0a0-0b1a-4b1a-9b0a-0b1a0b1a0b1a"
}

Apply Template

Request

Apply a template to the target tenant for creating instances. Add prefix '/rec' for REC templates.

Path
templateIdstringrequired
tenantIdstringrequired
Headers
Authorizationstringrequired
Body
required
overridesArray of objects(JsonNode)

List of key value pairs to override the template. Only venue template is supported with overriding the following attributes: name, description, address.addressLine, address.city, address.country, address.countryCode, address.latitude, address.longitude, and address.timezone.

Example: [{"key1":"value1","key2":"value2"}]
{
  "overrides": [
    { … }
  ]
}

Responses

OK

Body
requestIdstring
Response
{
  "requestId": "string"
}

Query Drift Instances

Request

Query drift instances with filter for template. Add prefix '/rec' for REC templates.

Path
templateIdstringrequired
Query
pageinteger(int32)
Default 1
pageSizeinteger(int32)
Default 20
Body
required
filterobject(QueryTemplateInstanceFilter)
{
  "filter": {
    "status": "DRIFT"
  }
}

Responses

OK

Body
dataArray of objects(DriftInstance)
pageinteger(int64)
totalCountinteger(int64)
Response
{
  "data": [
    { … }
  ],
  "page": 0,
  "totalCount": 0
}

Query Template Dependency

Request

Query template dependency (direct children only) for a specific template with pagination and sorting. Add prefix '/rec' for REC templates.

Path
templateIdstringrequired
Body
required
pageinteger(int32)
pageSizeinteger(int32)
{
  "page": 0,
  "pageSize": 0
}

Responses

OK

Body
fieldsany
totalCountinteger(int64)
pageinteger(int32)
pageSizeinteger(int32)
requestIdstring
dataArray of objects(HierarchyNode)
Response
{
  "fields": null,
  "totalCount": 0,
  "page": 0,
  "pageSize": 0,
  "requestId": "string",
  "data": [
    { … }
  ]
}

Retrieve Diff Reports

Request

Retrieve diff reports from drift tenant.

Path
templateIdstringrequired
tenantIdstringrequired
No request payload

Responses

OK

Body
Array [
diffNamestring
diffDataArray of objects(DiffData)
]
Response
[
  {
    "diffName": "string",
    "diffData": [ … ]
  }
]

Sync Template

Request

Sync the configuration template to a drift tenant.

Path
templateIdstringrequired
tenantIdstringrequired
Headers
Authorizationstringrequired
No request payload

Responses

Accepted

Body
requestIdstring
Response
{
  "requestId": "b3d3a0a0-0b1a-4b1a-9b0a-0b1a0b1a0b1a"
}