Skip to content

Config Template Service API & Model Documentation (1.0.0)

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 Configuration Templates.

Operations

Set Template Enforcement Settings

Request

Set 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.

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
fieldsobject
totalCountinteger(int64)
pageinteger(int32)
pageSizeinteger(int32)
requestIdstring
dataArray of objects(HierarchyNode)
Response
{
  "fields": {},
  "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"
}