Resources

Endpoints

The following are some of the commonly used endpoints available via the API:

• activity/api/Query
• catalog/api/applications
• catalog/api/application/{id}/import
• catalog/api/application/{id}/export
• catalog/api/application/{id}/run
• catalog/api/deployments
• catalog/api/statefulSets
• catalog/api/podTemplateSpecs
• catalog/api/podSpecs
• catalog/api/volumes
• catalog/networkPolicies
• catalog/api/services
• catalog/api/ingresses
• catalog/api/configMaps
• catalog/api/secrets
• cluster/api/hostClusters
• cluster/api/nodes
• cluster/api/nodes
• cluster/api/events
• cluster/api/namespaces
• cluster/api/storageClasses
• cluster/api/persistentVolumes
• cluster/api/nodeStats
• cluster/api/clusterStats
• cluster/api/pendingPods
• cluster/api/clusterPolicies
• cluster/api/clusterRoles
• cluster/api/clusterRoleBindings
• environments/api/environments
• environments/api/applications
• environments/api/application/{id}/import
• environments/api/application/{id}/export
• environments/api/deployments
• environments/api/statefulSets
• environments/api/podTemplateSpecs
• environments/api/podSpecs
• environments/api/volumes
• environments/networkPolicies
• environments/api/services
• environments/api/ingresses
• environments/api/configMaps
• environments/api/secrets
• environments/api/podSpecs
• environments/api/volumes
• environments/networkPolicies
• environments/api/services
• environments/api/ingresses
• environments/api/configMaps

Usage Details

For the activity API, use the POST method and specify the Query spec in the payload. Example,

{
   "index": "audit_trail*",
   "timeframe": "Custom",
   "eventType": "User",
   "numRecords": 10,
   "page": 1,
   "start": 1722495600000,
   "end": 1722841199000,
   "filter": {
       "modelIndex": [
           "Alarm",
           "AlarmNotifier",
           "AlarmType",
           "ClusterAddOnAction",
           "ClusterComplianceReport",
           "ComplianceControl",
           "ComplianceStandard",
           "KyvernoConfig",
           "KyvernoPolicy",
           "KyvernoPolicySpec",
           "OidcIdpSettings",
           "OperatorEvent",
           "PolicyException",
           "PolicyExceptionRequest",
           "PolicyGroup",
           "PolicyGroupCluster",
           "PolicyKustomization",
           "PolicyReportNotification",
           "PolicyReportSchedule"
       ],
       "label": [
           "^Pod: kyverno.*$",
           "^Service: kyverno.*$",
           "^Deployment: kyverno.*$",
           "^Application: kyverno.*$"
       ]
   }
}

• index must be audit_trail*.
• timeframe is a required field. The acceptable values are LastFiveMinutes, LastFifteenMinutes, LastHour, LastDay, LastWeek, LastMonth, or Custom.
• start is required when Custom is specified for timeframe.
• end is required when Custom is specified for timeframe.
• eventType can accept values to be System, User, All. The default value is All.
• page / numRecords can be used for pagination.