Skip to content

Adaptive Policy Management (0.0.9)

Overview

The Adaptive Policy Management REST APIs and Model, allow the creation, deletion, and modification of policies, policy sets, and assigning policies to policy sets. All policies must be inherited from a policy template. Only those evaluation conditions that are defined for the template can be assigned to the policy. Once a policy is assigned to a policy set, it must be given an evaluation priority. If the priority is changed, or a policy added or removed, the priority of the other policies will be automatically re-ordered.

What This API Does

  • Create, modify, and delete policies
  • Manage policy sets and assignments
  • Configure policy templates and evaluation conditions
  • Set and manage policy priorities

Authentication

All API calls require valid authentication via Bearer token in Authorization header.

Error Handling

The API uses standard HTTP status codes with detailed error messages in the response body.

Common Error Responses

All endpoints may return these common error responses:

  • 400 Bad Request: Invalid input data or validation errors
  • 401 Unauthorized: Missing or invalid authentication
  • 403 Forbidden: Insufficient permissions
  • 404 Not Found: Requested resource doesn't exist
  • 409 Conflict: Resource conflict (e.g., duplicate names)
  • 422 Unprocessable Entity: Business rule violations
  • 500 Internal Server Error: Unexpected server errors
Download OpenAPI description
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/

Policy Conditions

Manage the conditions that are applied on the specified policy.

Operations

Policy Set Assignments

Manage the assignments of policy sets to identities.

Operations

Policy Templates

View the list of policy templates.

Operations

Policies

Manages, create and get of policies assigned to a specific template.

Operations

Prioritized Policies

Manage the prioritized policies within a policy set.

Operations

Policy Sets

Manages the policy sets.

Operations

Create Policy Set

Request

Creates a policy set from the requested values.

Bodyrequired
idstring(uuid)

The identifier for this dynamic policy.

namestringrequired

The policy set name.

descriptionstringrequired

The policy set description.

mappedPolicyCountinteger(int64)

The number of policies mapped to this policy set.

assignmentCountinteger(int64)

The number of assignments to this policy set.

policyNamesArray of strings

The names of the policies mapped to this policy set.

externalAssignmentsArray of objects(Policy Set Assignment Groups)

The list of external assignments assigned to this policy set.

policyOverrideEnabledboolean

The policy override enabled flag.

_linksobject(Links)
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "description": "string", "mappedPolicyCount": 0, "assignmentCount": 0, "policyNames": [ "string" ], "externalAssignments": [ {} ], "policyOverrideEnabled": true, "_links": { "property1": {}, "property2": {} } }

Responses

Policy set created

Bodyapplication/json
idstring(uuid)

The identifier for this dynamic policy.

namestringrequired

The policy set name.

descriptionstringrequired

The policy set description.

mappedPolicyCountinteger(int64)

The number of policies mapped to this policy set.

assignmentCountinteger(int64)

The number of assignments to this policy set.

policyNamesArray of strings

The names of the policies mapped to this policy set.

externalAssignmentsArray of objects(Policy Set Assignment Groups)

The list of external assignments assigned to this policy set.

policyOverrideEnabledboolean

The policy override enabled flag.

_linksobject(Links)
Response
application/json
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "description": "string", "mappedPolicyCount": 0, "assignmentCount": 0, "policyNames": [ "string" ], "externalAssignments": [ {} ], "policyOverrideEnabled": true, "_links": { "property1": {}, "property2": {} } }

Query Policy Sets

Request

Returns the list of policy sets using the specified query.

Query
excludeContentboolean
Default false
Bodyrequired
sortFieldstring

The field to use to sort on.

sortOrderstring

Defines the sort direction for query results.

Enum"ASC""DESC"
pageinteger(int32)>= 0

The page number to return, paging starts with 0.

pageSizeinteger(int32)[ 1 .. 2000 ]

The number of items requested on the page.

filtersobject

The list of filters to apply.

{ "sortField": "string", "sortOrder": "ASC", "page": 0, "pageSize": 1, "filters": { "property1": {}, "property2": {} } }

Responses

List Policy Sets in a paged format.

Bodyapplication/json
pagingobject(Page Data)

Pagination metadata for query results including total count, current page, page size, and total pages

contentArray of objects(Policy Set)

The content list of the data.

_linksobject(Links)
Response
application/json
{ "paging": { "totalCount": 0, "page": 0, "pageSize": 0, "pageCount": 0 }, "content": [ {} ], "_links": { "property1": {}, "property2": {} } }

Get Policy Set

Request

Retrieves the requested policy set.

Path
policySetIdstring(uuid)required

Policy set identifier.

No request payload

Responses

Policy set found

Body
idstring(uuid)

The identifier for this dynamic policy.

namestringrequired

The policy set name.

descriptionstringrequired

The policy set description.

mappedPolicyCountinteger(int64)

The number of policies mapped to this policy set.

assignmentCountinteger(int64)

The number of assignments to this policy set.

policyNamesArray of strings

The names of the policies mapped to this policy set.

externalAssignmentsArray of objects(Policy Set Assignment Groups)

The list of external assignments assigned to this policy set.

policyOverrideEnabledboolean

The policy override enabled flag.

_linksobject(Links)
Response
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "description": "string", "mappedPolicyCount": 0, "assignmentCount": 0, "policyNames": [ "string" ], "externalAssignments": [ {} ], "policyOverrideEnabled": true, "_links": { "property1": {}, "property2": {} } }

Delete Policy Set

Request

Deletes the policy set, may not be assigned to a service.

Path
policySetIdstring(uuid)required

Policy set identifier.

No request payload

Responses

Policy set deleted

Body
object
Response
{}

Update Policy Set

Request

Updates the policy set from the requested values.

Path
policySetIdstring(uuid)required

Policy set identifier.

Bodyrequired
idstring(uuid)

The identifier for this dynamic policy.

namestringrequired

The policy set name.

descriptionstringrequired

The policy set description.

mappedPolicyCountinteger(int64)

The number of policies mapped to this policy set.

assignmentCountinteger(int64)

The number of assignments to this policy set.

policyNamesArray of strings

The names of the policies mapped to this policy set.

externalAssignmentsArray of objects(Policy Set Assignment Groups)

The list of external assignments assigned to this policy set.

policyOverrideEnabledboolean

The policy override enabled flag.

_linksobject(Links)
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "description": "string", "mappedPolicyCount": 0, "assignmentCount": 0, "policyNames": [ "string" ], "externalAssignments": [ {} ], "policyOverrideEnabled": true, "_links": { "property1": {}, "property2": {} } }

Responses

Policy set updated

Bodyapplication/json
idstring(uuid)

The identifier for this dynamic policy.

namestringrequired

The policy set name.

descriptionstringrequired

The policy set description.

mappedPolicyCountinteger(int64)

The number of policies mapped to this policy set.

assignmentCountinteger(int64)

The number of assignments to this policy set.

policyNamesArray of strings

The names of the policies mapped to this policy set.

externalAssignmentsArray of objects(Policy Set Assignment Groups)

The list of external assignments assigned to this policy set.

policyOverrideEnabledboolean

The policy override enabled flag.

_linksobject(Links)
Response
application/json
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "description": "string", "mappedPolicyCount": 0, "assignmentCount": 0, "policyNames": [ "string" ], "externalAssignments": [ {} ], "policyOverrideEnabled": true, "_links": { "property1": {}, "property2": {} } }