Get Policy

Returns the details of a specific policy by name, including its rules, criteria, actions, and metadata (author, created/modified timestamps, assigned watches).

Requires the Read Policies role to be set on the User or Group level. For Xray version 3.21.2 and above with Projects, a Project Admin with Manage Security Assets privilege can get a policy by using the additional query parameter projectKey. When projectKey is provided, the policy is looked up in both the project scope and globally.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The name of the policy to retrieve.

Query Params
string

When provided, looks up the policy in the scope of the specified project as well as globally. Requires Xray 3.21.2+ with Projects enabled.

string
enum

When set to true, includes notification-related action fields in the response.

Allowed:
Responses

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json