Get Changes Made over Specified Period

Returns all changes (regulatory compliance, baseline compliance, and security rating scores changes, rules changes, risk changes, etc.) made to host groups, services, applications, or rules over a specified period.

Resource Name: /api/v1/seikan/journal/{deviceName}/interval/{startTime}/{endTime}

Request Method: GET

Request Parameters

Parameter Type Description
deviceName

mandatory

string Device name. Use GET /devices to retrieve the device name.
startTime

mandatory

integer Start time of changes (UNIX timestamp).
endTime

mandatory

integer End time of changes (UNIX timestamp).
pdfMode boolean

Whether to return the information for print.

cURL Example 

curl -X GET "https://localhost/api/v1/seikan/journal/device123/interval/1609459200/1612137600?pdfMode=false" \
	-H "Authorization: Bearer your-token"

Status Codes

Code Description
200 OK
400 Bad Request
401 Unauthorized
403 The session does not have permissions to the device.
404 Unknown device
423 Locked
429 Too Many Requests
500 Internal Server Error
503 Service Unavailable

Response Parameters

Parameter Type Description
startTime Number Start time (UNIX timestamp) of the changes.
endTime Number End time (UNIX timestamp) of the changes.
device Object Information about the device where changes were detected.
type String Type of the result set (for example, SINGLE).
scoresChanges Object Information about any score-related changes (e.g. compliance scores). Empty if no changes.
ckpSpecialObjChanges Object Check Point special object changes (empty if none).
changesStatus Object Detailed summary of all changes detected.

device

Parameter Type Description
treeName String The internal tree name of the device (e.g. the unique identifier in the system).
displayName String Human-readable name for the device.
brand String Brand or vendor of the device (e.g. "panorama").

changesStatus

Parameter Type Description
ruleChanges Object Information about rule changes.
natRuleChanges Object Information about NAT rule changes.
communityChanges Object Information about community changes.
userChanges Object Information about user account changes.
policyChanges Object Information about policy changes.
globalPropertiesChanges Object Information about changes to global properties.
serviceChanges Object Information about service-related changes.
applicationChanges Object Information about application-related changes.
networkObjectChanges Object Information about network object changes.
interfaceChanges Object Information about interface changes.
riskChanges Object Information about risk-related changes.
configurationsChanges Object Information about configuration changes (contains extra flags, e.g. displayChangeType).
fullConfigurationDiffs Object Information about full configuration differences.
baselineComplianceChanges Object Information about baseline compliance changes.
auditLogRecords Object Information about audit log records.
legacyChangesOverTimeHtml Object Legacy HTML data describing past changes over time.
summary String Summary string (e.g. "NO_CHANGES") indicating overall status.
totalNumberChanges Number Total number of changes across all categories.
visibleChangesTabs Array of Strings List of change categories that should be visible (e.g. ["topology", "policy", ...]).

Sub-Object Structure Example: ruleChanges, natRuleChanges, etc.

Parameter Type Description
status String The change status ("NO_CHANGES", "CHANGED", etc.).
count Number Number of changes in this category.
excludeFromTotal Boolean Whether these changes should be excluded from the total count.
displayChangeType Boolean (Only in some objects like configurationsChanges) Whether to display the type of change.
displayChangeIP Boolean (Only in some objects like configurationsChanges) Whether to display changed IP addresses.

Response Example Success 200

Copy
{
  "startTime": 0,
  "endTime": 100000000,
  "device": {
    "treeName": "pl_pp_pano_den_chi_btdevfw_a_vsys1",
    "displayName": "chi-btdevfw-a_vsys1",
    "brand": "panorama"
  },
  "type": "SINGLE",
  "scoresChanges": {},
  "ckpSpecialObjChanges": {},
  "changesStatus": {
    "ruleChanges": {
      "status": "NO_CHANGES",
      "count": 0,
      "excludeFromTotal": false
    },
    "natRuleChanges": {
      "status": "NO_CHANGES",
      "count": 0,
      "excludeFromTotal": false
    },
    "communityChanges": {
      "status": "NO_CHANGES",
      "count": 0,
      "excludeFromTotal": false
    },
    "userChanges": {
      "status": "NO_CHANGES",
      "count": 0,
      "excludeFromTotal": false
    },
    "policyChanges": {
      "status": "NO_CHANGES",
      "count": 0,
      "excludeFromTotal": false
    },
    "globalPropertiesChanges": {
      "status": "NO_CHANGES",
      "count": 0,
      "excludeFromTotal": false
    },
    "serviceChanges": {
      "status": "NO_CHANGES",
      "count": 0,
      "excludeFromTotal": false
    },
    "applicationChanges": {
      "status": "NO_CHANGES",
      "count": 0,
      "excludeFromTotal": false
    },
    "networkObjectChanges": {
      "status": "NO_CHANGES",
      "count": 0,
      "excludeFromTotal": false
    },
    "interfaceChanges": {
      "status": "NO_CHANGES",
      "count": 0,
      "excludeFromTotal": false
    },
    "riskChanges": {
      "status": "NO_CHANGES",
      "count": 0,
      "excludeFromTotal": false
    },
    "configurationsChanges": {
      "status": "NO_CHANGES",
      "count": 0,
      "excludeFromTotal": false,
      "displayChangeType": false,
      "displayChangeIP": false
    },
    "fullConfigurationDiffs": {
      "status": "NO_CHANGES",
      "count": 0,
      "excludeFromTotal": false
    },
    "baselineComplianceChanges": {
      "status": "NO_CHANGES",
      "count": 0,
      "excludeFromTotal": false
    },
    "auditLogRecords": {
      "status": "NO_CHANGES",
      "count": 0,
      "excludeFromTotal": false
    },
    "legacyChangesOverTimeHtml": {
      "status": "NO_CHANGES",
      "count": 0,
      "excludeFromTotal": false
    },
    "summary": "NO_CHANGES",
    "totalNumberChanges": 0,
    "visibleChangesTabs": [
      "topology",
      "policy",
      "baseline-compliance",
      "risks",
      "vpn",
      "configuration",
      "rules",
      "audit"
    ]
  }
}

Response Example Failure 400

Copy
{
  "error": "string",
  "description": "string",
  "fieldErrors": [
    {
      "field": "string",
      "error": "string"
    }
  ]
}