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
Download PDF
Overview
License

RUCKUS Cloud Privacy Policy

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

Get Prioritized Policy

Request

Retrieves the requested prioritized policy.

Path
policySetIdstring(uuid)required

Policy set identifier.

policyIdstring(uuid)required

Policy identifier.

No request payload

Responses

Prioritized policy found

Body
policyIdstring(uuid)

The identifier for the prioritized policy. Will be ignored on a put, as URL is the identifier.

priorityinteger(int32)

The priority of this policy, 1 being the highest priority.

_linksobject(Links)
Response
{
  "policyId": "2f5573e6-5ba4-48f2-a75d-df99c936463b",
  "priority": 0,
  "_links": {
    "property1": { … },
    "property2": { … }
  }
}

Assign Policy to Policy Set

Request

Assigns a policy to a policy set with a specific priority.

Path
policySetIdstring(uuid)required

Policy set identifier.

policyIdstring(uuid)required

Policy identifier.

Body
required
policyIdstring(uuid)

The identifier for the prioritized policy. Will be ignored on a put, as URL is the identifier.

priorityinteger(int32)

The priority of this policy, 1 being the highest priority.

_linksobject(Links)
{
  "policyId": "2f5573e6-5ba4-48f2-a75d-df99c936463b",
  "priority": 0,
  "_links": {
    "property1": { … },
    "property2": { … }
  }
}

Responses

Policy assigned to policy set

Body
policyIdstring(uuid)

The identifier for the prioritized policy. Will be ignored on a put, as URL is the identifier.

priorityinteger(int32)

The priority of this policy, 1 being the highest priority.

_linksobject(Links)
Response
{
  "policyId": "2f5573e6-5ba4-48f2-a75d-df99c936463b",
  "priority": 0,
  "_links": {
    "property1": { … },
    "property2": { … }
  }
}

Remove Policy from Policy Set

Request

Removes a policy from a policy set.

Path
policySetIdstring(uuid)required

Policy set identifier.

policyIdstring(uuid)required

Policy identifier.

No request payload

Responses

Policy removed from policy set successfully.

Body
object

Empty response object for successful removal

Response
{}

Get Prioritized Policies

Request

Gets the list of prioritized policies for the specified policy set.

Path
policySetIdstring(uuid)required

Policy set identifier.

No request payload

Responses

Prioritized policies in a paged format.

Body
pagingobject(Page Data)

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

contentArray of objects(Prioritized Policy)

The content list of the data.

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

Policy Sets

Manages the policy sets.

Operations