Audit API¶

The Audit API allows you to retrieve historical evaluation records to track policy and ruleset compliance over time.

Policy Audits¶

List Policy Audits¶

Retrieve audit records for policy evaluations.

GET /api/audits/policies/{policy_name}

Path Parameters:

Parameter	Description
`policy_name`	Name of the policy to retrieve audits for

Query Parameters:

Parameter	Description
`startTimestamp`	Start date/time for the query in ISO 8601 format
`endTimestamp`	End date/time for the query in ISO 8601 format
`page`	Page number (default: 1)
`pageSize`	Number of records to return per page (default: 10)

Example RequestResponse Body

curl -X GET "https://<your-instance>.aegis.pegasys.cloud/api/audits/policies/demo?startTimestamp=2025-01-01T00:00:00Z&endTimestamp=2025-07-01T00:00:00Z&pageSize=10" \
  -H "Authorization: Bearer <your_token>"

{
  "policyName": "demo",
  "startTimestamp": "2025-01-01T00:00:00Z",
  "endTimestamp": "2025-07-01T00:00:00Z",
  "page": 1,
  "pageSize": 10,
  "policyAudits": [
    {
      "policyName": "demo",
      "input": "{\"apiVersion\":\"apps/v1\",\"kind\":\"Deployment\"}",
      "inputFormat": "json",
      "output": {
        "policy": "demo",
        "passed": false,
        "results": []
      },
      "updatedAt": "2025-06-10T15:30:00Z",
      "updatedBy": "user@example.com",
      "requestId": "req-123-456"
    }
  ]
}

List All Policy Audits¶

Retrieve audit records for all policies.

GET /api/audits/policies

Query Parameters:

Parameter	Description
`policy_name`	Filter by policy name (default: "*" for all)
`startTimestamp`	Start date/time for the query in ISO 8601 format
`endTimestamp`	End date/time for the query in ISO 8601 format
`page`	Page number (default: 1)
`pageSize`	Number of records to return per page (default: 10)

Count Policy Audits¶

Get a count of policy audit records for the specified time range.

GET /api/audits/count/policies/{policy_name}

Path Parameters:

Parameter	Description
`policy_name`	Name of the policy to count audits for

Query Parameters:

Parameter	Description
`startTimestamp`	Start date/time for the query in ISO 8601 format
`endTimestamp`	End date/time for the query in ISO 8601 format

Example RequestResponse Body

curl -X GET "https://<your-instance>.aegis.pegasys.cloud/api/audits/count/policies/demo?startTimestamp=2025-06-07T18:33:39Z&endTimestamp=2025-06-14T18:33:39Z" \
  -H "Authorization: Bearer <your_token>"

{
  "policyName": "demo",
  "policyAuditsCount": 542,
  "startTimestamp": "2025-06-07T18:33:39Z",
  "endTimestamp": "2025-06-14T18:33:39Z"
}

Get Policy Audit by Request ID¶

Retrieve a specific policy audit by request ID.

GET /api/audits/policies/uuid/{request_id}

Path Parameters:

Parameter	Description
`request_id`	The request ID of the audit record to retrieve

Example RequestResponse Body

curl -X GET "https://<your-instance>.aegis.pegasys.cloud/api/audits/policies/uuid/req-123-456" \
  -H "Authorization: Bearer <your_token>"

{
  "requestId": "req-123-456",
  "policyAudit": {
    "policyName": "demo",
    "input": "{\"apiVersion\":\"apps/v1\",\"kind\":\"Deployment\"}",
    "inputFormat": "json",
    "output": {
      "policy": "demo",
      "passed": false,
      "results": []
    },
    "updatedAt": "2025-06-10T15:30:00Z",
    "updatedBy": "user@example.com",
    "requestId": "req-123-456"
  }
}

Ruleset Audits¶

List Ruleset Audits¶

Retrieve audit records for ruleset evaluations.

GET /api/audits/rulesets/{ruleset_name}

Path Parameters:

Parameter	Description
`ruleset_name`	Name of the ruleset to retrieve audits for

Query Parameters:

Parameter	Description
`startTimestamp`	Start date/time for the query in ISO 8601 format
`endTimestamp`	End date/time for the query in ISO 8601 format
`page`	Page number (default: 1)
`pageSize`	Number of records to return per page (default: 10)

Example RequestResponse Body

curl -X GET "https://<your-instance>.aegis.pegasys.cloud/api/audits/rulesets/demo?startTimestamp=2025-01-01T00:00:00Z&endTimestamp=2025-07-01T00:00:00Z&pageSize=10" \
  -H "Authorization: Bearer <your_token>"

{
  "rulesetName": "demo",
  "startTimestamp": "2025-01-01T00:00:00Z",
  "endTimestamp": "2025-07-01T00:00:00Z",
  "page": 1,
  "pageSize": 10,
  "rulesetAudits": [
    {
      "rulesetName": "demo",
      "input": "{\"apiVersion\":\"apps/v1\",\"kind\":\"Deployment\"}",
      "inputFormat": "json",
      "output": {
        "ruleset": "demo",
        "passed": false,
        "results": []
      },
      "updatedAt": "2025-06-10T15:30:00Z",
      "updatedBy": "user@example.com",
      "requestId": "req-789-012"
    }
  ]
}

List All Ruleset Audits¶

Retrieve audit records for all rulesets.

GET /api/audits/rulesets

Query Parameters:

Parameter	Description
`ruleset_name`	Filter by ruleset name (default: "*" for all)
`startTimestamp`	Start date/time for the query in ISO 8601 format
`endTimestamp`	End date/time for the query in ISO 8601 format
`page`	Page number (default: 1)
`pageSize`	Number of records to return per page (default: 10)

Count Ruleset Audits¶

Get a count of ruleset audit records for the specified time range.

GET /api/audits/count/rulesets/{ruleset_name}

Path Parameters:

Parameter	Description
`ruleset_name`	Name of the ruleset to count audits for

Query Parameters:

Parameter	Description
`startTimestamp`	Start date/time for the query in ISO 8601 format
`endTimestamp`	End date/time for the query in ISO 8601 format

Example RequestResponse Body

curl -X GET "https://<your-instance>.aegis.pegasys.cloud/api/audits/count/rulesets/demo?startTimestamp=2025-06-07T18:33:39Z&endTimestamp=2025-06-14T18:33:39Z" \
  -H "Authorization: Bearer <your_token>"

{
  "rulesetName": "demo",
  "rulesetAuditsCount": 324,
  "startTimestamp": "2025-06-07T18:33:39Z",
  "endTimestamp": "2025-06-14T18:33:39Z"
}

Get Ruleset Audit by Request ID¶

Retrieve a specific ruleset audit by request ID.

GET /api/audits/rulesets/uuid/{request_id}

Path Parameters:

Parameter	Description
`request_id`	The request ID of the audit record to retrieve

Example RequestResponse Body

curl -X GET "https://<your-instance>.aegis.pegasys.cloud/api/audits/rulesets/uuid/req-789-012" \
  -H "Authorization: Bearer <your_token>"

{
  "requestId": "req-789-012",
  "rulesetAudits": [
    {
      "rulesetName": "demo",
      "input": "{\"apiVersion\":\"apps/v1\",\"kind\":\"Deployment\"}",
      "inputFormat": "json",
      "output": {
        "ruleset": "demo",
        "passed": false,
        "results": []
      },
      "updatedAt": "2025-06-10T15:30:00Z",
      "updatedBy": "user@example.com",
      "requestId": "req-789-012"
    }
  ]
}