FileCatalogDetailDto

FileCatalogDetailDto
FileCatalogDetailDto

A catalog entry with its instances. Absent fields are omitted from the JSON.

JSON Example
{
    "fileId": 0,
    "fileName": "string",
    "sha256": "string",
    "fileKind": "string",
    "publisher": "string",
    "globalState": "string",
    "hypervisorCount": 0,
    "rule": {
        "ruleId": 0,
        "name": "string",
        "action": "string",
        "ruleRank": "string",
        "isEnabled": false,
        "attachment": "string",
        "attachedPolicyCount": 0
    },
    "fileSize": 0,
    "instances": [
        {
            "endpointId": "string",
            "hostname": "string",
            "path": "string"
        }
    ]
}
integer As int64 As int64
fileId
Required  

Identifier of the catalog entry; there is one entry per distinct SHA-256, created when an agent first reports the hash

string
fileName
Required  

Last path segment of the path under which an agent first reported the hash, cut to 255 characters. Later reports of the same hash under another name do not change it

string As ^[a-f0-9]{64}$
sha256
Required  

64 lowercase hex characters

fileKind
Optional

Kind of file as classified by the agent.

  • ELF: The agent classified the file by its ELF header (0x7f followed by ELF)
  • SCRIPT: The agent classified the file by a leading #! line
  • EXECUTABLE_OTHER: The agent qualified the file only by its executable permission
Enumeration: ELF, SCRIPT, EXECUTABLE_OTHER
string
publisher
Optional

Absent until the agent reports a publisher or signer

globalState
Required  

Global file catalog state. It follows the action of the mapped rule: no rule or AUDIT is UNAPPROVED, ALLOW is APPROVED, BLOCK is BANNED.

  • UNAPPROVED: The entry has no rule or its rule's action is AUDIT; the state of a new entry
  • APPROVED: The entry's rule has the action ALLOW
  • BANNED: The entry's rule has the action BLOCK
Enumeration: UNAPPROVED, APPROVED, BANNED
integer As int64 As int64
hypervisorCount
Required  

Number of distinct hypervisors that currently have the file

rule
Optional

The catalog rule of an entry.

integer As int64 As int64
fileSize
Optional

File size in bytes as first reported by an agent. Omitted when the agent reported none

instances
Required  
Constraints: maxItems: 1000

At most 1,000 instances, ordered by hostname then path