Servers

Policies
 1.0.0 
OAS3

Use the Policies API to create and manage issue policies, component policies and test scheduling policies.

  • Issue policies: Use issue policies to automate actions when issues with specific properties are detected in a test (including setting fix-by dates, if necessary).
  • Component policies: Use component policies to automate actions when a component with specific properties are detected in a test.
  • Test frequency policies: Use test scheduling policies to automate tests of SCM-integrated branches on a weekly or daily basis.

Base path change and deprecation notice

The base path for the Policy Management service is changing (from /api/risk to /api/policies). The /api/risk/ base path will continue to function until Mon, 15 Sept 2025 23:59:59 GMT.

Additionally, several endpoints are being deprecated. Endpoints that are being deprecated include additional properties in response headers:

"Deprecation":  "Fri, 1 Nov 2024 23:59:59 GMT",
"Link":         "New version of API link; rel=\"alternate\"",
"Sunset":       "Mon, 15 Sept 2025 23:59:59 GMT"
  • Deprecation: The date and time when a resource will be deprecated. After this date, the resource may be removed from future versions of the API.

  • Link: A link to a supported endpoint that replicates the functionality of a deprecated one.

  • Sunset: The date and time when a resource will be removed, and no longer be available.

  • Note: Media type names used in Polaris APIs were renamed and no longer include “synopsys”. Although media types that include “synopsys” were removed from the API specifications, existing endpoints will continue to support them until September 1, 2025. Please update your scripts to use the new media types.

Policy Actions

Retrieve policy actions and their details.

GET​/api​/risk​/policies​/actions
List supported actions and their IDs
GET​/api​/policies​/actions
List supported actions and their IDs

Issue Policies

Manage issue policies.

POST​/api​/policies​/issue-policies
Create an issue policy
GET​/api​/risk​/policies​/issue-policy​/{id}
Get an issue policy’s details
PUT​/api​/risk​/policies​/issue-policy​/{id}
Update an issue policy’s properties
GET​/api​/policies​/issue-policies​/{id}
Get an issue policy’s details
PUT​/api​/policies​/issue-policies​/{id}
Update an issue policy’s properties

Component Policies

Manage component policies.

POST​/api​/policies​/component-policies
Create a new component policy
GET​/api​/policies​/component-policies
Find component policies with specific properties
GET​/api​/policies​/component-policies​/{id}
Fetch a component policy by ID
PUT​/api​/policies​/component-policies​/{id}
Update a component policy's details
DELETE​/api​/policies​/component-policies​/{id}
Delete an existing component policy by ID

Policy Assignments

Assign policies to projects.

DELETE​/api​/risk​/policies​/{policyId}​/assignments​/{id}
Delete a policy assignment by `assignment id`
POST​/api​/risk​/policies​/{policyId}​/bulk-assign
Associate multiple projects to a policy in bulk
POST​/api​/risk​/policies​/{policyId}​/bulk-unassign
Un-Associate multiple projects from a policy
POST​/api​/risk​/policies​/{policyId}​/default
Set your organization’s default policies
GET​/api​/risk​/policies​/{policyId}​/assignments
Find project assignments for a Policy

Policy Assignments V2

Assign policies to projects.

POST​/api​/policies​/assignments
Assign a policy to one or more projects or branches
DELETE​/api​/policies​/assignments
Delete policy assignments
GET​/api​/policies​/assignments
Get a policy’s assignments
GET​/api​/policies​/assignments​/id
Get policy assignment details

Policy Settings

Manage your organization's policy settings.

POST​/api​/policies​/policy-settings
Set your organization’s default policies

Test Scheduling Policies

Manage test scheduling policies.

POST​/api​/risk​/policies​/test-frequency-policy
Create a test scheduling policy
POST​/api​/policies​/test-scheduling-policies
Create a test scheduling policy
GET​/api​/policies​/test-scheduling-policies
List test scheduling policies
GET​/api​/risk​/policies​/test-frequency-policy​/{id}
Get a test scheduling policy’s details
PUT​/api​/risk​/policies​/test-frequency-policy​/{id}
Update a test scheduling policy’s properties
GET​/api​/policies​/test-scheduling-policies​/{id}
Get a test scheduling policy’s details
PUT​/api​/policies​/test-scheduling-policies​/{id}
Update a test scheduling policy’s properties
DELETE​/api​/policies​/test-scheduling-policies​/{id}
Delete a test scheduling policy

Portfolio Policy Configuration

Manage portfolio policies.

GET​/api​/risk​/policies​/portfolio-policy-configuration
Find Portfolio Policy Configuration for the organization using filter criteria.
POST​/api​/risk​/policies​/portfolio-policy-configuration
Create or update Portfolio Policy Configuration for an organization
GET​/api​/policies​/portfolio-policy-configuration
Find Portfolio Policy Configuration for the organization using filter criteria.
POST​/api​/policies​/portfolio-policy-configuration
Create or update Portfolio Policy Configuration for an organization
GET​/api​/risk​/policies​/portfolio-policy-configuration​/{id}
Get a portfolio policy configuration’s details.
GET​/api​/policies​/portfolio-policy-configuration​/{id}
Fetch Portfolio Policy Configuration by id.

Issue Policy Execution

Issue policy execution endpoints.

GET​/api​/risk​/policies​/issue-policy-execution
Find Issue Policy Execution for the testId
GET​/api​/policies​/issue-policies​/execution
Find Issue Policy Execution for the testId
GET​/api​/risk​/policies​/issue-policy-execution​/{id}
Fetch Issue Policy execution details by execution id
GET​/api​/policies​/issue-policies​/execution​/{id}
Fetch Issue Policy execution details by execution id

Issue Policy Evaluation

Issue policy evaluation endpoints.

GET​/api​/policies​/issue-policies​/evaluations
Get a list of policy evaluations
GET​/api​/risk​/policies​/issue-policy​/issues-violating-policies​/counts
Get the quantity of issues that violate issue policies in applications, projects, or branches
GET​/api​/policies​/issue-policies​/violations​/counts
Get the quantity of issues that violate issue policies in applications, projects, or branches

Policy Evaluations

Policy evaluation endpoints.

GET​/api​/policies​/evaluations​/{id}
Get a policy evaluation's details using its ID

Policy Violations

Policy Violations endpoints.

GET​/api​/policies​/policy-violations
Fetch policy violations for the supplied filters

Active Violation Counts

Active Violation Counts endpoints.

GET​/api​/policies​/violation-counts
Fetch policy violation counts

Schemas

Actions
ActionsGetResponse
PolicyActionsGetResponse
IssuePolicyPolicyPayload
IssuePolicyPolicyCollectionResponse
IssuePolicyPoliciesCollectionResponse
IssuePolicyResponse
IssuePoliciesResponse
FilterGroups
PowerFilterRule
FixByRule
Filter
Usage
PolicyAssignmentPayload
PolicyAssignmentResponse
PoliciesAssignmentResponse
PolicyBulkAssignmentPayload
BulkAssignmentItem
BulkAssignmentsPayload
BulkAssignmentsItem
PolicySettingsPayload
PolicyBulkAssignmentRemovalPayload
BulkAssignmentRemovalItem
Collections
TestFrequencyPolicyPayload
TestFrequencyPolicyCollectionResponse
TestSchedulingPolicyCollectionResponse
TestFrequencyPolicyResponse
TestSchedulingPolicyResponse
ScheduleGroups
ScheduleRule
IssuePolicyExecutionResponse
IssuePoliciesExecutionResponse
ActivatedActionResponse
PortfolioPolicyConfigurationRequest
PortfolioPolicyConfigurationResponse
PortfolioPoliciesConfigurationResponse
AssignedPolicyResponse
IssuePolicyExecutionCollectionResponse
IssuePoliciesExecutionCollectionResponse
PortfolioPolicyConfigurationCollectionResponse
PortfolioPoliciesConfigurationCollectionResponse
IssueViolationCountResponse
IssueViolationCountCollectionResponse
IssueViolationsCountCollectionResponse
IssuePolicyEvaluationResponse
IssuePoliciesEvaluationResponse
IssuePolicyEvaluationCollectionResponse
IssuePoliciesEvaluationCollectionResponse
Rules
Policy
Policies
RuleActivatedAction
RuleEvaluationSummary
PolicyEvaluationSummary
PolicyEvaluationContext
PolicyEvaluationResponse
PolicyEvaluationsCollectionResponse
UsecaseViolationCount
ActiveViolationCountItem
ActiveViolationCountCollectionResponse
ViolatedPolicyOfEntity
ViolatingEntity
ViolatingEntityCollectionResponse
CriteriaFilter
ComponentPolicyRule
ComponentPolicyItem
ComponentPolicyCollectionResponse