Skip to content

Policy Evaluation (0.0.3)

Overview

The Policy Evaluation REST API's allow the evaluation of a policy with the provided criteria. A policy with attributes set, where the provided criteria is not provided will always fail. The text for matching criteria can be found in the policy criteria attributes in the policy management API.

What This API Does

  • Evaluate policies against provided criteria
  • Return evaluation results with detailed results to apply
  • Support for complex policy evaluation scenarios

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
  • 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

Criteria Evaluation

Evaluates policy criteria provided and identifies the matching policy.

Operations

Evaluate Criteria

Request

Evaluates the criteria provided and returns the matched response from the first matching policy within the specified set, or it will indicate that no match was found. A policy has additional required criteria and no matching test criteria is provided, that will be considered a failure. Additional test attributes that are provided but are not required within a policy will be ignored and not considered a match failure.

Path
policySetIdstring(uuid)required
Bodyrequired
null

Responses

Policy set was evaluated and results are returned.

Body
Response
No content